<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.commons.io;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.ArrayDeque;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.ArrayList;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Arrays;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Collection;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Deque;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Objects;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.regex.Matcher;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.regex.Pattern;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * General file name and file path manipulation utilities.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;p&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * When dealing with file names you can hit problems when moving from a Windows<a name="line.34"></a>
<span class="sourceLineNo">035</span> * based development machine to a Unix based production machine.<a name="line.35"></a>
<span class="sourceLineNo">036</span> * This class aims to help avoid those problems.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;b&gt;NOTE&lt;/b&gt;: You may be able to avoid using this class entirely simply by<a name="line.38"></a>
<span class="sourceLineNo">039</span> * using JDK {@link java.io.File File} objects and the two argument constructor<a name="line.39"></a>
<span class="sourceLineNo">040</span> * {@link java.io.File#File(java.io.File, java.lang.String) File(File,String)}.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;p&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Most methods on this class are designed to work the same on both Unix and Windows.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * Those that don't include 'System', 'Unix' or 'Windows' in their name.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Most methods recognise both separators (forward and back), and both<a name="line.45"></a>
<span class="sourceLineNo">046</span> * sets of prefixes. See the javadoc of each method for details.<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;p&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> * This class defines six components within a file name<a name="line.48"></a>
<span class="sourceLineNo">049</span> * (example C:\dev\project\file.txt):<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;ul&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;li&gt;the prefix - C:\&lt;/li&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> * &lt;li&gt;the path - dev\project\&lt;/li&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;li&gt;the full path - C:\dev\project\&lt;/li&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;li&gt;the name - file.txt&lt;/li&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;li&gt;the base name - file&lt;/li&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * &lt;li&gt;the extension - txt&lt;/li&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;/ul&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> * Note that this class works best if directory file names end with a separator.<a name="line.58"></a>
<span class="sourceLineNo">059</span> * If you omit the last separator, it is impossible to determine if the file name<a name="line.59"></a>
<span class="sourceLineNo">060</span> * corresponds to a file or a directory. As a result, we have chosen to say<a name="line.60"></a>
<span class="sourceLineNo">061</span> * it corresponds to a file.<a name="line.61"></a>
<span class="sourceLineNo">062</span> * &lt;p&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * This class only supports Unix and Windows style names.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Prefixes are matched as follows:<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;pre&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * Windows:<a name="line.66"></a>
<span class="sourceLineNo">067</span> * a\b\c.txt           --&amp;gt; ""          --&amp;gt; relative<a name="line.67"></a>
<span class="sourceLineNo">068</span> * \a\b\c.txt          --&amp;gt; "\"         --&amp;gt; current drive absolute<a name="line.68"></a>
<span class="sourceLineNo">069</span> * C:a\b\c.txt         --&amp;gt; "C:"        --&amp;gt; drive relative<a name="line.69"></a>
<span class="sourceLineNo">070</span> * C:\a\b\c.txt        --&amp;gt; "C:\"       --&amp;gt; absolute<a name="line.70"></a>
<span class="sourceLineNo">071</span> * \\server\a\b\c.txt  --&amp;gt; "\\server\" --&amp;gt; UNC<a name="line.71"></a>
<span class="sourceLineNo">072</span> *<a name="line.72"></a>
<span class="sourceLineNo">073</span> * Unix:<a name="line.73"></a>
<span class="sourceLineNo">074</span> * a/b/c.txt           --&amp;gt; ""          --&amp;gt; relative<a name="line.74"></a>
<span class="sourceLineNo">075</span> * /a/b/c.txt          --&amp;gt; "/"         --&amp;gt; absolute<a name="line.75"></a>
<span class="sourceLineNo">076</span> * ~/a/b/c.txt         --&amp;gt; "~/"        --&amp;gt; current user<a name="line.76"></a>
<span class="sourceLineNo">077</span> * ~                   --&amp;gt; "~/"        --&amp;gt; current user (slash added)<a name="line.77"></a>
<span class="sourceLineNo">078</span> * ~user/a/b/c.txt     --&amp;gt; "~user/"    --&amp;gt; named user<a name="line.78"></a>
<span class="sourceLineNo">079</span> * ~user               --&amp;gt; "~user/"    --&amp;gt; named user (slash added)<a name="line.79"></a>
<span class="sourceLineNo">080</span> * &lt;/pre&gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span> * Both prefix styles are matched always, irrespective of the machine that you are<a name="line.81"></a>
<span class="sourceLineNo">082</span> * currently running on.<a name="line.82"></a>
<span class="sourceLineNo">083</span> * &lt;p&gt;<a name="line.83"></a>
<span class="sourceLineNo">084</span> * Origin of code: Excalibur, Alexandria, Tomcat, Commons-Utils.<a name="line.84"></a>
<span class="sourceLineNo">085</span> *<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @since 1.1<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span>public class FilenameUtils {<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span>    private static final String[] EMPTY_STRING_ARRAY = new String[0];<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    private static final String EMPTY_STRING = "";<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span>    private static final int NOT_FOUND = -1;<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>    /**<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * The extension separator character.<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * @since 1.4<a name="line.98"></a>
<span class="sourceLineNo">099</span>     */<a name="line.99"></a>
<span class="sourceLineNo">100</span>    public static final char EXTENSION_SEPARATOR = '.';<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span>    /**<a name="line.102"></a>
<span class="sourceLineNo">103</span>     * The extension separator String.<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * @since 1.4<a name="line.104"></a>
<span class="sourceLineNo">105</span>     */<a name="line.105"></a>
<span class="sourceLineNo">106</span>    public static final String EXTENSION_SEPARATOR_STR = Character.toString(EXTENSION_SEPARATOR);<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span>    /**<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * The Unix separator character.<a name="line.109"></a>
<span class="sourceLineNo">110</span>     */<a name="line.110"></a>
<span class="sourceLineNo">111</span>    private static final char UNIX_SEPARATOR = '/';<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span>    /**<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * The Windows separator character.<a name="line.114"></a>
<span class="sourceLineNo">115</span>     */<a name="line.115"></a>
<span class="sourceLineNo">116</span>    private static final char WINDOWS_SEPARATOR = '\\';<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span>    /**<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * The system separator character.<a name="line.119"></a>
<span class="sourceLineNo">120</span>     */<a name="line.120"></a>
<span class="sourceLineNo">121</span>    private static final char SYSTEM_SEPARATOR = File.separatorChar;<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span>    /**<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * The separator character that is the opposite of the system separator.<a name="line.124"></a>
<span class="sourceLineNo">125</span>     */<a name="line.125"></a>
<span class="sourceLineNo">126</span>    private static final char OTHER_SEPARATOR;<a name="line.126"></a>
<span class="sourceLineNo">127</span>    static {<a name="line.127"></a>
<span class="sourceLineNo">128</span>        if (isSystemWindows()) {<a name="line.128"></a>
<span class="sourceLineNo">129</span>            OTHER_SEPARATOR = UNIX_SEPARATOR;<a name="line.129"></a>
<span class="sourceLineNo">130</span>        } else {<a name="line.130"></a>
<span class="sourceLineNo">131</span>            OTHER_SEPARATOR = WINDOWS_SEPARATOR;<a name="line.131"></a>
<span class="sourceLineNo">132</span>        }<a name="line.132"></a>
<span class="sourceLineNo">133</span>    }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span>    /**<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * Instances should NOT be constructed in standard programming.<a name="line.136"></a>
<span class="sourceLineNo">137</span>     */<a name="line.137"></a>
<span class="sourceLineNo">138</span>    public FilenameUtils() {<a name="line.138"></a>
<span class="sourceLineNo">139</span>        super();<a name="line.139"></a>
<span class="sourceLineNo">140</span>    }<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span>    //-----------------------------------------------------------------------<a name="line.142"></a>
<span class="sourceLineNo">143</span>    /**<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * Determines if Windows file system is in use.<a name="line.144"></a>
<span class="sourceLineNo">145</span>     *<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * @return true if the system is Windows<a name="line.146"></a>
<span class="sourceLineNo">147</span>     */<a name="line.147"></a>
<span class="sourceLineNo">148</span>    static boolean isSystemWindows() {<a name="line.148"></a>
<span class="sourceLineNo">149</span>        return SYSTEM_SEPARATOR == WINDOWS_SEPARATOR;<a name="line.149"></a>
<span class="sourceLineNo">150</span>    }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span>    //-----------------------------------------------------------------------<a name="line.152"></a>
<span class="sourceLineNo">153</span>    /**<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * Checks if the character is a separator.<a name="line.154"></a>
<span class="sourceLineNo">155</span>     *<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * @param ch  the character to check<a name="line.156"></a>
<span class="sourceLineNo">157</span>     * @return true if it is a separator character<a name="line.157"></a>
<span class="sourceLineNo">158</span>     */<a name="line.158"></a>
<span class="sourceLineNo">159</span>    private static boolean isSeparator(final char ch) {<a name="line.159"></a>
<span class="sourceLineNo">160</span>        return ch == UNIX_SEPARATOR || ch == WINDOWS_SEPARATOR;<a name="line.160"></a>
<span class="sourceLineNo">161</span>    }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span>    //-----------------------------------------------------------------------<a name="line.163"></a>
<span class="sourceLineNo">164</span>    /**<a name="line.164"></a>
<span class="sourceLineNo">165</span>     * Normalizes a path, removing double and single dot path steps.<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * &lt;p&gt;<a name="line.166"></a>
<span class="sourceLineNo">167</span>     * This method normalizes a path to a standard format.<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * The input may contain separators in either Unix or Windows format.<a name="line.168"></a>
<span class="sourceLineNo">169</span>     * The output will contain separators in the format of the system.<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * &lt;p&gt;<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * A trailing slash will be retained.<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * A double slash will be merged to a single slash (but UNC names are handled).<a name="line.172"></a>
<span class="sourceLineNo">173</span>     * A single dot path segment will be removed.<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * A double dot will cause that path segment and the one before to be removed.<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * If the double dot has no parent path segment to work with, {@code null}<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * is returned.<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * &lt;p&gt;<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * The output will be the same on both Unix and Windows except<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * for the separator character.<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * &lt;pre&gt;<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * /foo//               --&amp;gt;   /foo/<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * /foo/./              --&amp;gt;   /foo/<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * /foo/../bar          --&amp;gt;   /bar<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * /foo/../bar/         --&amp;gt;   /bar/<a name="line.184"></a>
<span class="sourceLineNo">185</span>     * /foo/../bar/../baz   --&amp;gt;   /baz<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * //foo//./bar         --&amp;gt;   /foo/bar<a name="line.186"></a>
<span class="sourceLineNo">187</span>     * /../                 --&amp;gt;   null<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * ../foo               --&amp;gt;   null<a name="line.188"></a>
<span class="sourceLineNo">189</span>     * foo/bar/..           --&amp;gt;   foo/<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * foo/../../bar        --&amp;gt;   null<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * foo/../bar           --&amp;gt;   bar<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * //server/foo/../bar  --&amp;gt;   //server/bar<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * //server/../bar      --&amp;gt;   null<a name="line.193"></a>
<span class="sourceLineNo">194</span>     * C:\foo\..\bar        --&amp;gt;   C:\bar<a name="line.194"></a>
<span class="sourceLineNo">195</span>     * C:\..\bar            --&amp;gt;   null<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * ~/foo/../bar/        --&amp;gt;   ~/bar/<a name="line.196"></a>
<span class="sourceLineNo">197</span>     * ~/../bar             --&amp;gt;   null<a name="line.197"></a>
<span class="sourceLineNo">198</span>     * &lt;/pre&gt;<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * (Note the file separator returned will be correct for Windows/Unix)<a name="line.199"></a>
<span class="sourceLineNo">200</span>     *<a name="line.200"></a>
<span class="sourceLineNo">201</span>     * @param fileName  the fileName to normalize, null returns null<a name="line.201"></a>
<span class="sourceLineNo">202</span>     * @return the normalized fileName, or null if invalid. Null bytes inside string will be removed<a name="line.202"></a>
<span class="sourceLineNo">203</span>     */<a name="line.203"></a>
<span class="sourceLineNo">204</span>    public static String normalize(final String fileName) {<a name="line.204"></a>
<span class="sourceLineNo">205</span>        return doNormalize(fileName, SYSTEM_SEPARATOR, true);<a name="line.205"></a>
<span class="sourceLineNo">206</span>    }<a name="line.206"></a>
<span class="sourceLineNo">207</span>    /**<a name="line.207"></a>
<span class="sourceLineNo">208</span>     * Normalizes a path, removing double and single dot path steps.<a name="line.208"></a>
<span class="sourceLineNo">209</span>     * &lt;p&gt;<a name="line.209"></a>
<span class="sourceLineNo">210</span>     * This method normalizes a path to a standard format.<a name="line.210"></a>
<span class="sourceLineNo">211</span>     * The input may contain separators in either Unix or Windows format.<a name="line.211"></a>
<span class="sourceLineNo">212</span>     * The output will contain separators in the format specified.<a name="line.212"></a>
<span class="sourceLineNo">213</span>     * &lt;p&gt;<a name="line.213"></a>
<span class="sourceLineNo">214</span>     * A trailing slash will be retained.<a name="line.214"></a>
<span class="sourceLineNo">215</span>     * A double slash will be merged to a single slash (but UNC names are handled).<a name="line.215"></a>
<span class="sourceLineNo">216</span>     * A single dot path segment will be removed.<a name="line.216"></a>
<span class="sourceLineNo">217</span>     * A double dot will cause that path segment and the one before to be removed.<a name="line.217"></a>
<span class="sourceLineNo">218</span>     * If the double dot has no parent path segment to work with, {@code null}<a name="line.218"></a>
<span class="sourceLineNo">219</span>     * is returned.<a name="line.219"></a>
<span class="sourceLineNo">220</span>     * &lt;p&gt;<a name="line.220"></a>
<span class="sourceLineNo">221</span>     * The output will be the same on both Unix and Windows except<a name="line.221"></a>
<span class="sourceLineNo">222</span>     * for the separator character.<a name="line.222"></a>
<span class="sourceLineNo">223</span>     * &lt;pre&gt;<a name="line.223"></a>
<span class="sourceLineNo">224</span>     * /foo//               --&amp;gt;   /foo/<a name="line.224"></a>
<span class="sourceLineNo">225</span>     * /foo/./              --&amp;gt;   /foo/<a name="line.225"></a>
<span class="sourceLineNo">226</span>     * /foo/../bar          --&amp;gt;   /bar<a name="line.226"></a>
<span class="sourceLineNo">227</span>     * /foo/../bar/         --&amp;gt;   /bar/<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * /foo/../bar/../baz   --&amp;gt;   /baz<a name="line.228"></a>
<span class="sourceLineNo">229</span>     * //foo//./bar         --&amp;gt;   /foo/bar<a name="line.229"></a>
<span class="sourceLineNo">230</span>     * /../                 --&amp;gt;   null<a name="line.230"></a>
<span class="sourceLineNo">231</span>     * ../foo               --&amp;gt;   null<a name="line.231"></a>
<span class="sourceLineNo">232</span>     * foo/bar/..           --&amp;gt;   foo/<a name="line.232"></a>
<span class="sourceLineNo">233</span>     * foo/../../bar        --&amp;gt;   null<a name="line.233"></a>
<span class="sourceLineNo">234</span>     * foo/../bar           --&amp;gt;   bar<a name="line.234"></a>
<span class="sourceLineNo">235</span>     * //server/foo/../bar  --&amp;gt;   //server/bar<a name="line.235"></a>
<span class="sourceLineNo">236</span>     * //server/../bar      --&amp;gt;   null<a name="line.236"></a>
<span class="sourceLineNo">237</span>     * C:\foo\..\bar        --&amp;gt;   C:\bar<a name="line.237"></a>
<span class="sourceLineNo">238</span>     * C:\..\bar            --&amp;gt;   null<a name="line.238"></a>
<span class="sourceLineNo">239</span>     * ~/foo/../bar/        --&amp;gt;   ~/bar/<a name="line.239"></a>
<span class="sourceLineNo">240</span>     * ~/../bar             --&amp;gt;   null<a name="line.240"></a>
<span class="sourceLineNo">241</span>     * &lt;/pre&gt;<a name="line.241"></a>
<span class="sourceLineNo">242</span>     * The output will be the same on both Unix and Windows including<a name="line.242"></a>
<span class="sourceLineNo">243</span>     * the separator character.<a name="line.243"></a>
<span class="sourceLineNo">244</span>     *<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * @param fileName  the fileName to normalize, null returns null<a name="line.245"></a>
<span class="sourceLineNo">246</span>     * @param unixSeparator {@code true} if a unix separator should<a name="line.246"></a>
<span class="sourceLineNo">247</span>     * be used or {@code false} if a windows separator should be used.<a name="line.247"></a>
<span class="sourceLineNo">248</span>     * @return the normalized fileName, or null if invalid. Null bytes inside string will be removed<a name="line.248"></a>
<span class="sourceLineNo">249</span>     * @since 2.0<a name="line.249"></a>
<span class="sourceLineNo">250</span>     */<a name="line.250"></a>
<span class="sourceLineNo">251</span>    public static String normalize(final String fileName, final boolean unixSeparator) {<a name="line.251"></a>
<span class="sourceLineNo">252</span>        final char separator = unixSeparator ? UNIX_SEPARATOR : WINDOWS_SEPARATOR;<a name="line.252"></a>
<span class="sourceLineNo">253</span>        return doNormalize(fileName, separator, true);<a name="line.253"></a>
<span class="sourceLineNo">254</span>    }<a name="line.254"></a>
<span class="sourceLineNo">255</span><a name="line.255"></a>
<span class="sourceLineNo">256</span>    //-----------------------------------------------------------------------<a name="line.256"></a>
<span class="sourceLineNo">257</span>    /**<a name="line.257"></a>
<span class="sourceLineNo">258</span>     * Normalizes a path, removing double and single dot path steps,<a name="line.258"></a>
<span class="sourceLineNo">259</span>     * and removing any final directory separator.<a name="line.259"></a>
<span class="sourceLineNo">260</span>     * &lt;p&gt;<a name="line.260"></a>
<span class="sourceLineNo">261</span>     * This method normalizes a path to a standard format.<a name="line.261"></a>
<span class="sourceLineNo">262</span>     * The input may contain separators in either Unix or Windows format.<a name="line.262"></a>
<span class="sourceLineNo">263</span>     * The output will contain separators in the format of the system.<a name="line.263"></a>
<span class="sourceLineNo">264</span>     * &lt;p&gt;<a name="line.264"></a>
<span class="sourceLineNo">265</span>     * A trailing slash will be removed.<a name="line.265"></a>
<span class="sourceLineNo">266</span>     * A double slash will be merged to a single slash (but UNC names are handled).<a name="line.266"></a>
<span class="sourceLineNo">267</span>     * A single dot path segment will be removed.<a name="line.267"></a>
<span class="sourceLineNo">268</span>     * A double dot will cause that path segment and the one before to be removed.<a name="line.268"></a>
<span class="sourceLineNo">269</span>     * If the double dot has no parent path segment to work with, {@code null}<a name="line.269"></a>
<span class="sourceLineNo">270</span>     * is returned.<a name="line.270"></a>
<span class="sourceLineNo">271</span>     * &lt;p&gt;<a name="line.271"></a>
<span class="sourceLineNo">272</span>     * The output will be the same on both Unix and Windows except<a name="line.272"></a>
<span class="sourceLineNo">273</span>     * for the separator character.<a name="line.273"></a>
<span class="sourceLineNo">274</span>     * &lt;pre&gt;<a name="line.274"></a>
<span class="sourceLineNo">275</span>     * /foo//               --&amp;gt;   /foo<a name="line.275"></a>
<span class="sourceLineNo">276</span>     * /foo/./              --&amp;gt;   /foo<a name="line.276"></a>
<span class="sourceLineNo">277</span>     * /foo/../bar          --&amp;gt;   /bar<a name="line.277"></a>
<span class="sourceLineNo">278</span>     * /foo/../bar/         --&amp;gt;   /bar<a name="line.278"></a>
<span class="sourceLineNo">279</span>     * /foo/../bar/../baz   --&amp;gt;   /baz<a name="line.279"></a>
<span class="sourceLineNo">280</span>     * //foo//./bar         --&amp;gt;   /foo/bar<a name="line.280"></a>
<span class="sourceLineNo">281</span>     * /../                 --&amp;gt;   null<a name="line.281"></a>
<span class="sourceLineNo">282</span>     * ../foo               --&amp;gt;   null<a name="line.282"></a>
<span class="sourceLineNo">283</span>     * foo/bar/..           --&amp;gt;   foo<a name="line.283"></a>
<span class="sourceLineNo">284</span>     * foo/../../bar        --&amp;gt;   null<a name="line.284"></a>
<span class="sourceLineNo">285</span>     * foo/../bar           --&amp;gt;   bar<a name="line.285"></a>
<span class="sourceLineNo">286</span>     * //server/foo/../bar  --&amp;gt;   //server/bar<a name="line.286"></a>
<span class="sourceLineNo">287</span>     * //server/../bar      --&amp;gt;   null<a name="line.287"></a>
<span class="sourceLineNo">288</span>     * C:\foo\..\bar        --&amp;gt;   C:\bar<a name="line.288"></a>
<span class="sourceLineNo">289</span>     * C:\..\bar            --&amp;gt;   null<a name="line.289"></a>
<span class="sourceLineNo">290</span>     * ~/foo/../bar/        --&amp;gt;   ~/bar<a name="line.290"></a>
<span class="sourceLineNo">291</span>     * ~/../bar             --&amp;gt;   null<a name="line.291"></a>
<span class="sourceLineNo">292</span>     * &lt;/pre&gt;<a name="line.292"></a>
<span class="sourceLineNo">293</span>     * (Note the file separator returned will be correct for Windows/Unix)<a name="line.293"></a>
<span class="sourceLineNo">294</span>     *<a name="line.294"></a>
<span class="sourceLineNo">295</span>     * @param fileName  the fileName to normalize, null returns null<a name="line.295"></a>
<span class="sourceLineNo">296</span>     * @return the normalized fileName, or null if invalid. Null bytes inside string will be removed<a name="line.296"></a>
<span class="sourceLineNo">297</span>     */<a name="line.297"></a>
<span class="sourceLineNo">298</span>    public static String normalizeNoEndSeparator(final String fileName) {<a name="line.298"></a>
<span class="sourceLineNo">299</span>        return doNormalize(fileName, SYSTEM_SEPARATOR, false);<a name="line.299"></a>
<span class="sourceLineNo">300</span>    }<a name="line.300"></a>
<span class="sourceLineNo">301</span><a name="line.301"></a>
<span class="sourceLineNo">302</span>    /**<a name="line.302"></a>
<span class="sourceLineNo">303</span>     * Normalizes a path, removing double and single dot path steps,<a name="line.303"></a>
<span class="sourceLineNo">304</span>     * and removing any final directory separator.<a name="line.304"></a>
<span class="sourceLineNo">305</span>     * &lt;p&gt;<a name="line.305"></a>
<span class="sourceLineNo">306</span>     * This method normalizes a path to a standard format.<a name="line.306"></a>
<span class="sourceLineNo">307</span>     * The input may contain separators in either Unix or Windows format.<a name="line.307"></a>
<span class="sourceLineNo">308</span>     * The output will contain separators in the format specified.<a name="line.308"></a>
<span class="sourceLineNo">309</span>     * &lt;p&gt;<a name="line.309"></a>
<span class="sourceLineNo">310</span>     * A trailing slash will be removed.<a name="line.310"></a>
<span class="sourceLineNo">311</span>     * A double slash will be merged to a single slash (but UNC names are handled).<a name="line.311"></a>
<span class="sourceLineNo">312</span>     * A single dot path segment will be removed.<a name="line.312"></a>
<span class="sourceLineNo">313</span>     * A double dot will cause that path segment and the one before to be removed.<a name="line.313"></a>
<span class="sourceLineNo">314</span>     * If the double dot has no parent path segment to work with, {@code null}<a name="line.314"></a>
<span class="sourceLineNo">315</span>     * is returned.<a name="line.315"></a>
<span class="sourceLineNo">316</span>     * &lt;p&gt;<a name="line.316"></a>
<span class="sourceLineNo">317</span>     * The output will be the same on both Unix and Windows including<a name="line.317"></a>
<span class="sourceLineNo">318</span>     * the separator character.<a name="line.318"></a>
<span class="sourceLineNo">319</span>     * &lt;pre&gt;<a name="line.319"></a>
<span class="sourceLineNo">320</span>     * /foo//               --&amp;gt;   /foo<a name="line.320"></a>
<span class="sourceLineNo">321</span>     * /foo/./              --&amp;gt;   /foo<a name="line.321"></a>
<span class="sourceLineNo">322</span>     * /foo/../bar          --&amp;gt;   /bar<a name="line.322"></a>
<span class="sourceLineNo">323</span>     * /foo/../bar/         --&amp;gt;   /bar<a name="line.323"></a>
<span class="sourceLineNo">324</span>     * /foo/../bar/../baz   --&amp;gt;   /baz<a name="line.324"></a>
<span class="sourceLineNo">325</span>     * //foo//./bar         --&amp;gt;   /foo/bar<a name="line.325"></a>
<span class="sourceLineNo">326</span>     * /../                 --&amp;gt;   null<a name="line.326"></a>
<span class="sourceLineNo">327</span>     * ../foo               --&amp;gt;   null<a name="line.327"></a>
<span class="sourceLineNo">328</span>     * foo/bar/..           --&amp;gt;   foo<a name="line.328"></a>
<span class="sourceLineNo">329</span>     * foo/../../bar        --&amp;gt;   null<a name="line.329"></a>
<span class="sourceLineNo">330</span>     * foo/../bar           --&amp;gt;   bar<a name="line.330"></a>
<span class="sourceLineNo">331</span>     * //server/foo/../bar  --&amp;gt;   //server/bar<a name="line.331"></a>
<span class="sourceLineNo">332</span>     * //server/../bar      --&amp;gt;   null<a name="line.332"></a>
<span class="sourceLineNo">333</span>     * C:\foo\..\bar        --&amp;gt;   C:\bar<a name="line.333"></a>
<span class="sourceLineNo">334</span>     * C:\..\bar            --&amp;gt;   null<a name="line.334"></a>
<span class="sourceLineNo">335</span>     * ~/foo/../bar/        --&amp;gt;   ~/bar<a name="line.335"></a>
<span class="sourceLineNo">336</span>     * ~/../bar             --&amp;gt;   null<a name="line.336"></a>
<span class="sourceLineNo">337</span>     * &lt;/pre&gt;<a name="line.337"></a>
<span class="sourceLineNo">338</span>     *<a name="line.338"></a>
<span class="sourceLineNo">339</span>     * @param fileName  the fileName to normalize, null returns null<a name="line.339"></a>
<span class="sourceLineNo">340</span>     * @param unixSeparator {@code true} if a unix separator should<a name="line.340"></a>
<span class="sourceLineNo">341</span>     * be used or {@code false} if a windows separator should be used.<a name="line.341"></a>
<span class="sourceLineNo">342</span>     * @return the normalized fileName, or null if invalid. Null bytes inside string will be removed<a name="line.342"></a>
<span class="sourceLineNo">343</span>     * @since 2.0<a name="line.343"></a>
<span class="sourceLineNo">344</span>     */<a name="line.344"></a>
<span class="sourceLineNo">345</span>    public static String normalizeNoEndSeparator(final String fileName, final boolean unixSeparator) {<a name="line.345"></a>
<span class="sourceLineNo">346</span>         final char separator = unixSeparator ? UNIX_SEPARATOR : WINDOWS_SEPARATOR;<a name="line.346"></a>
<span class="sourceLineNo">347</span>        return doNormalize(fileName, separator, false);<a name="line.347"></a>
<span class="sourceLineNo">348</span>    }<a name="line.348"></a>
<span class="sourceLineNo">349</span><a name="line.349"></a>
<span class="sourceLineNo">350</span>    /**<a name="line.350"></a>
<span class="sourceLineNo">351</span>     * Internal method to perform the normalization.<a name="line.351"></a>
<span class="sourceLineNo">352</span>     *<a name="line.352"></a>
<span class="sourceLineNo">353</span>     * @param fileName  the fileName<a name="line.353"></a>
<span class="sourceLineNo">354</span>     * @param separator The separator character to use<a name="line.354"></a>
<span class="sourceLineNo">355</span>     * @param keepSeparator  true to keep the final separator<a name="line.355"></a>
<span class="sourceLineNo">356</span>     * @return the normalized fileName. Null bytes inside string will be removed.<a name="line.356"></a>
<span class="sourceLineNo">357</span>     */<a name="line.357"></a>
<span class="sourceLineNo">358</span>    private static String doNormalize(final String fileName, final char separator, final boolean keepSeparator) {<a name="line.358"></a>
<span class="sourceLineNo">359</span>        if (fileName == null) {<a name="line.359"></a>
<span class="sourceLineNo">360</span>            return null;<a name="line.360"></a>
<span class="sourceLineNo">361</span>        }<a name="line.361"></a>
<span class="sourceLineNo">362</span><a name="line.362"></a>
<span class="sourceLineNo">363</span>        failIfNullBytePresent(fileName);<a name="line.363"></a>
<span class="sourceLineNo">364</span><a name="line.364"></a>
<span class="sourceLineNo">365</span>        int size = fileName.length();<a name="line.365"></a>
<span class="sourceLineNo">366</span>        if (size == 0) {<a name="line.366"></a>
<span class="sourceLineNo">367</span>            return fileName;<a name="line.367"></a>
<span class="sourceLineNo">368</span>        }<a name="line.368"></a>
<span class="sourceLineNo">369</span>        final int prefix = getPrefixLength(fileName);<a name="line.369"></a>
<span class="sourceLineNo">370</span>        if (prefix &lt; 0) {<a name="line.370"></a>
<span class="sourceLineNo">371</span>            return null;<a name="line.371"></a>
<span class="sourceLineNo">372</span>        }<a name="line.372"></a>
<span class="sourceLineNo">373</span><a name="line.373"></a>
<span class="sourceLineNo">374</span>        final char[] array = new char[size + 2];  // +1 for possible extra slash, +2 for arraycopy<a name="line.374"></a>
<span class="sourceLineNo">375</span>        fileName.getChars(0, fileName.length(), array, 0);<a name="line.375"></a>
<span class="sourceLineNo">376</span><a name="line.376"></a>
<span class="sourceLineNo">377</span>        // fix separators throughout<a name="line.377"></a>
<span class="sourceLineNo">378</span>        final char otherSeparator = separator == SYSTEM_SEPARATOR ? OTHER_SEPARATOR : SYSTEM_SEPARATOR;<a name="line.378"></a>
<span class="sourceLineNo">379</span>        for (int i = 0; i &lt; array.length; i++) {<a name="line.379"></a>
<span class="sourceLineNo">380</span>            if (array[i] == otherSeparator) {<a name="line.380"></a>
<span class="sourceLineNo">381</span>                array[i] = separator;<a name="line.381"></a>
<span class="sourceLineNo">382</span>            }<a name="line.382"></a>
<span class="sourceLineNo">383</span>        }<a name="line.383"></a>
<span class="sourceLineNo">384</span><a name="line.384"></a>
<span class="sourceLineNo">385</span>        // add extra separator on the end to simplify code below<a name="line.385"></a>
<span class="sourceLineNo">386</span>        boolean lastIsDirectory = true;<a name="line.386"></a>
<span class="sourceLineNo">387</span>        if (array[size - 1] != separator) {<a name="line.387"></a>
<span class="sourceLineNo">388</span>            array[size++] = separator;<a name="line.388"></a>
<span class="sourceLineNo">389</span>            lastIsDirectory = false;<a name="line.389"></a>
<span class="sourceLineNo">390</span>        }<a name="line.390"></a>
<span class="sourceLineNo">391</span><a name="line.391"></a>
<span class="sourceLineNo">392</span>        // adjoining slashes<a name="line.392"></a>
<span class="sourceLineNo">393</span>        for (int i = prefix + 1; i &lt; size; i++) {<a name="line.393"></a>
<span class="sourceLineNo">394</span>            if (array[i] == separator &amp;&amp; array[i - 1] == separator) {<a name="line.394"></a>
<span class="sourceLineNo">395</span>                System.arraycopy(array, i, array, i - 1, size - i);<a name="line.395"></a>
<span class="sourceLineNo">396</span>                size--;<a name="line.396"></a>
<span class="sourceLineNo">397</span>                i--;<a name="line.397"></a>
<span class="sourceLineNo">398</span>            }<a name="line.398"></a>
<span class="sourceLineNo">399</span>        }<a name="line.399"></a>
<span class="sourceLineNo">400</span><a name="line.400"></a>
<span class="sourceLineNo">401</span>        // dot slash<a name="line.401"></a>
<span class="sourceLineNo">402</span>        for (int i = prefix + 1; i &lt; size; i++) {<a name="line.402"></a>
<span class="sourceLineNo">403</span>            if (array[i] == separator &amp;&amp; array[i - 1] == '.' &amp;&amp;<a name="line.403"></a>
<span class="sourceLineNo">404</span>                    (i == prefix + 1 || array[i - 2] == separator)) {<a name="line.404"></a>
<span class="sourceLineNo">405</span>                if (i == size - 1) {<a name="line.405"></a>
<span class="sourceLineNo">406</span>                    lastIsDirectory = true;<a name="line.406"></a>
<span class="sourceLineNo">407</span>                }<a name="line.407"></a>
<span class="sourceLineNo">408</span>                System.arraycopy(array, i + 1, array, i - 1, size - i);<a name="line.408"></a>
<span class="sourceLineNo">409</span>                size -=2;<a name="line.409"></a>
<span class="sourceLineNo">410</span>                i--;<a name="line.410"></a>
<span class="sourceLineNo">411</span>            }<a name="line.411"></a>
<span class="sourceLineNo">412</span>        }<a name="line.412"></a>
<span class="sourceLineNo">413</span><a name="line.413"></a>
<span class="sourceLineNo">414</span>        // double dot slash<a name="line.414"></a>
<span class="sourceLineNo">415</span>        outer:<a name="line.415"></a>
<span class="sourceLineNo">416</span>        for (int i = prefix + 2; i &lt; size; i++) {<a name="line.416"></a>
<span class="sourceLineNo">417</span>            if (array[i] == separator &amp;&amp; array[i - 1] == '.' &amp;&amp; array[i - 2] == '.' &amp;&amp;<a name="line.417"></a>
<span class="sourceLineNo">418</span>                    (i == prefix + 2 || array[i - 3] == separator)) {<a name="line.418"></a>
<span class="sourceLineNo">419</span>                if (i == prefix + 2) {<a name="line.419"></a>
<span class="sourceLineNo">420</span>                    return null;<a name="line.420"></a>
<span class="sourceLineNo">421</span>                }<a name="line.421"></a>
<span class="sourceLineNo">422</span>                if (i == size - 1) {<a name="line.422"></a>
<span class="sourceLineNo">423</span>                    lastIsDirectory = true;<a name="line.423"></a>
<span class="sourceLineNo">424</span>                }<a name="line.424"></a>
<span class="sourceLineNo">425</span>                int j;<a name="line.425"></a>
<span class="sourceLineNo">426</span>                for (j = i - 4 ; j &gt;= prefix; j--) {<a name="line.426"></a>
<span class="sourceLineNo">427</span>                    if (array[j] == separator) {<a name="line.427"></a>
<span class="sourceLineNo">428</span>                        // remove b/../ from a/b/../c<a name="line.428"></a>
<span class="sourceLineNo">429</span>                        System.arraycopy(array, i + 1, array, j + 1, size - i);<a name="line.429"></a>
<span class="sourceLineNo">430</span>                        size -= i - j;<a name="line.430"></a>
<span class="sourceLineNo">431</span>                        i = j + 1;<a name="line.431"></a>
<span class="sourceLineNo">432</span>                        continue outer;<a name="line.432"></a>
<span class="sourceLineNo">433</span>                    }<a name="line.433"></a>
<span class="sourceLineNo">434</span>                }<a name="line.434"></a>
<span class="sourceLineNo">435</span>                // remove a/../ from a/../c<a name="line.435"></a>
<span class="sourceLineNo">436</span>                System.arraycopy(array, i + 1, array, prefix, size - i);<a name="line.436"></a>
<span class="sourceLineNo">437</span>                size -= i + 1 - prefix;<a name="line.437"></a>
<span class="sourceLineNo">438</span>                i = prefix + 1;<a name="line.438"></a>
<span class="sourceLineNo">439</span>            }<a name="line.439"></a>
<span class="sourceLineNo">440</span>        }<a name="line.440"></a>
<span class="sourceLineNo">441</span><a name="line.441"></a>
<span class="sourceLineNo">442</span>        if (size &lt;= 0) {  // should never be less than 0<a name="line.442"></a>
<span class="sourceLineNo">443</span>            return EMPTY_STRING;<a name="line.443"></a>
<span class="sourceLineNo">444</span>        }<a name="line.444"></a>
<span class="sourceLineNo">445</span>        if (size &lt;= prefix) {  // should never be less than prefix<a name="line.445"></a>
<span class="sourceLineNo">446</span>            return new String(array, 0, size);<a name="line.446"></a>
<span class="sourceLineNo">447</span>        }<a name="line.447"></a>
<span class="sourceLineNo">448</span>        if (lastIsDirectory &amp;&amp; keepSeparator) {<a name="line.448"></a>
<span class="sourceLineNo">449</span>            return new String(array, 0, size);  // keep trailing separator<a name="line.449"></a>
<span class="sourceLineNo">450</span>        }<a name="line.450"></a>
<span class="sourceLineNo">451</span>        return new String(array, 0, size - 1);  // lose trailing separator<a name="line.451"></a>
<span class="sourceLineNo">452</span>    }<a name="line.452"></a>
<span class="sourceLineNo">453</span><a name="line.453"></a>
<span class="sourceLineNo">454</span>    //-----------------------------------------------------------------------<a name="line.454"></a>
<span class="sourceLineNo">455</span>    /**<a name="line.455"></a>
<span class="sourceLineNo">456</span>     * Concatenates a fileName to a base path using normal command line style rules.<a name="line.456"></a>
<span class="sourceLineNo">457</span>     * &lt;p&gt;<a name="line.457"></a>
<span class="sourceLineNo">458</span>     * The effect is equivalent to resultant directory after changing<a name="line.458"></a>
<span class="sourceLineNo">459</span>     * directory to the first argument, followed by changing directory to<a name="line.459"></a>
<span class="sourceLineNo">460</span>     * the second argument.<a name="line.460"></a>
<span class="sourceLineNo">461</span>     * &lt;p&gt;<a name="line.461"></a>
<span class="sourceLineNo">462</span>     * The first argument is the base path, the second is the path to concatenate.<a name="line.462"></a>
<span class="sourceLineNo">463</span>     * The returned path is always normalized via {@link #normalize(String)},<a name="line.463"></a>
<span class="sourceLineNo">464</span>     * thus &lt;code&gt;..&lt;/code&gt; is handled.<a name="line.464"></a>
<span class="sourceLineNo">465</span>     * &lt;p&gt;<a name="line.465"></a>
<span class="sourceLineNo">466</span>     * If &lt;code&gt;pathToAdd&lt;/code&gt; is absolute (has an absolute prefix), then<a name="line.466"></a>
<span class="sourceLineNo">467</span>     * it will be normalized and returned.<a name="line.467"></a>
<span class="sourceLineNo">468</span>     * Otherwise, the paths will be joined, normalized and returned.<a name="line.468"></a>
<span class="sourceLineNo">469</span>     * &lt;p&gt;<a name="line.469"></a>
<span class="sourceLineNo">470</span>     * The output will be the same on both Unix and Windows except<a name="line.470"></a>
<span class="sourceLineNo">471</span>     * for the separator character.<a name="line.471"></a>
<span class="sourceLineNo">472</span>     * &lt;pre&gt;<a name="line.472"></a>
<span class="sourceLineNo">473</span>     * /foo/      + bar        --&amp;gt;  /foo/bar<a name="line.473"></a>
<span class="sourceLineNo">474</span>     * /foo       + bar        --&amp;gt;  /foo/bar<a name="line.474"></a>
<span class="sourceLineNo">475</span>     * /foo       + /bar       --&amp;gt;  /bar<a name="line.475"></a>
<span class="sourceLineNo">476</span>     * /foo       + C:/bar     --&amp;gt;  C:/bar<a name="line.476"></a>
<span class="sourceLineNo">477</span>     * /foo       + C:bar      --&amp;gt;  C:bar (*)<a name="line.477"></a>
<span class="sourceLineNo">478</span>     * /foo/a/    + ../bar     --&amp;gt;  /foo/bar<a name="line.478"></a>
<span class="sourceLineNo">479</span>     * /foo/      + ../../bar  --&amp;gt;  null<a name="line.479"></a>
<span class="sourceLineNo">480</span>     * /foo/      + /bar       --&amp;gt;  /bar<a name="line.480"></a>
<span class="sourceLineNo">481</span>     * /foo/..    + /bar       --&amp;gt;  /bar<a name="line.481"></a>
<span class="sourceLineNo">482</span>     * /foo       + bar/c.txt  --&amp;gt;  /foo/bar/c.txt<a name="line.482"></a>
<span class="sourceLineNo">483</span>     * /foo/c.txt + bar        --&amp;gt;  /foo/c.txt/bar (!)<a name="line.483"></a>
<span class="sourceLineNo">484</span>     * &lt;/pre&gt;<a name="line.484"></a>
<span class="sourceLineNo">485</span>     * (*) Note that the Windows relative drive prefix is unreliable when<a name="line.485"></a>
<span class="sourceLineNo">486</span>     * used with this method.<a name="line.486"></a>
<span class="sourceLineNo">487</span>     * (!) Note that the first parameter must be a path. If it ends with a name, then<a name="line.487"></a>
<span class="sourceLineNo">488</span>     * the name will be built into the concatenated path. If this might be a problem,<a name="line.488"></a>
<span class="sourceLineNo">489</span>     * use {@link #getFullPath(String)} on the base path argument.<a name="line.489"></a>
<span class="sourceLineNo">490</span>     *<a name="line.490"></a>
<span class="sourceLineNo">491</span>     * @param basePath  the base path to attach to, always treated as a path<a name="line.491"></a>
<span class="sourceLineNo">492</span>     * @param fullFileNameToAdd  the fileName (or path) to attach to the base<a name="line.492"></a>
<span class="sourceLineNo">493</span>     * @return the concatenated path, or null if invalid.  Null bytes inside string will be removed<a name="line.493"></a>
<span class="sourceLineNo">494</span>     */<a name="line.494"></a>
<span class="sourceLineNo">495</span>    public static String concat(final String basePath, final String fullFileNameToAdd) {<a name="line.495"></a>
<span class="sourceLineNo">496</span>        final int prefix = getPrefixLength(fullFileNameToAdd);<a name="line.496"></a>
<span class="sourceLineNo">497</span>        if (prefix &lt; 0) {<a name="line.497"></a>
<span class="sourceLineNo">498</span>            return null;<a name="line.498"></a>
<span class="sourceLineNo">499</span>        }<a name="line.499"></a>
<span class="sourceLineNo">500</span>        if (prefix &gt; 0) {<a name="line.500"></a>
<span class="sourceLineNo">501</span>            return normalize(fullFileNameToAdd);<a name="line.501"></a>
<span class="sourceLineNo">502</span>        }<a name="line.502"></a>
<span class="sourceLineNo">503</span>        if (basePath == null) {<a name="line.503"></a>
<span class="sourceLineNo">504</span>            return null;<a name="line.504"></a>
<span class="sourceLineNo">505</span>        }<a name="line.505"></a>
<span class="sourceLineNo">506</span>        final int len = basePath.length();<a name="line.506"></a>
<span class="sourceLineNo">507</span>        if (len == 0) {<a name="line.507"></a>
<span class="sourceLineNo">508</span>            return normalize(fullFileNameToAdd);<a name="line.508"></a>
<span class="sourceLineNo">509</span>        }<a name="line.509"></a>
<span class="sourceLineNo">510</span>        final char ch = basePath.charAt(len - 1);<a name="line.510"></a>
<span class="sourceLineNo">511</span>        if (isSeparator(ch)) {<a name="line.511"></a>
<span class="sourceLineNo">512</span>            return normalize(basePath + fullFileNameToAdd);<a name="line.512"></a>
<span class="sourceLineNo">513</span>        }<a name="line.513"></a>
<span class="sourceLineNo">514</span>        return normalize(basePath + '/' + fullFileNameToAdd);<a name="line.514"></a>
<span class="sourceLineNo">515</span>    }<a name="line.515"></a>
<span class="sourceLineNo">516</span><a name="line.516"></a>
<span class="sourceLineNo">517</span>    /**<a name="line.517"></a>
<span class="sourceLineNo">518</span>     * Determines whether the {@code parent} directory contains the {@code child} element (a file or directory).<a name="line.518"></a>
<span class="sourceLineNo">519</span>     * &lt;p&gt;<a name="line.519"></a>
<span class="sourceLineNo">520</span>     * The files names are expected to be normalized.<a name="line.520"></a>
<span class="sourceLineNo">521</span>     * &lt;/p&gt;<a name="line.521"></a>
<span class="sourceLineNo">522</span>     *<a name="line.522"></a>
<span class="sourceLineNo">523</span>     * Edge cases:<a name="line.523"></a>
<span class="sourceLineNo">524</span>     * &lt;ul&gt;<a name="line.524"></a>
<span class="sourceLineNo">525</span>     * &lt;li&gt;A {@code directory} must not be null: if null, throw IllegalArgumentException&lt;/li&gt;<a name="line.525"></a>
<span class="sourceLineNo">526</span>     * &lt;li&gt;A directory does not contain itself: return false&lt;/li&gt;<a name="line.526"></a>
<span class="sourceLineNo">527</span>     * &lt;li&gt;A null child file is not contained in any parent: return false&lt;/li&gt;<a name="line.527"></a>
<span class="sourceLineNo">528</span>     * &lt;/ul&gt;<a name="line.528"></a>
<span class="sourceLineNo">529</span>     *<a name="line.529"></a>
<span class="sourceLineNo">530</span>     * @param canonicalParent<a name="line.530"></a>
<span class="sourceLineNo">531</span>     *            the file to consider as the parent.<a name="line.531"></a>
<span class="sourceLineNo">532</span>     * @param canonicalChild<a name="line.532"></a>
<span class="sourceLineNo">533</span>     *            the file to consider as the child.<a name="line.533"></a>
<span class="sourceLineNo">534</span>     * @return true is the candidate leaf is under by the specified composite. False otherwise.<a name="line.534"></a>
<span class="sourceLineNo">535</span>     * @throws IOException<a name="line.535"></a>
<span class="sourceLineNo">536</span>     *             if an IO error occurs while checking the files.<a name="line.536"></a>
<span class="sourceLineNo">537</span>     * @since 2.2<a name="line.537"></a>
<span class="sourceLineNo">538</span>     * @see FileUtils#directoryContains(File, File)<a name="line.538"></a>
<span class="sourceLineNo">539</span>     */<a name="line.539"></a>
<span class="sourceLineNo">540</span>    public static boolean directoryContains(final String canonicalParent, final String canonicalChild)<a name="line.540"></a>
<span class="sourceLineNo">541</span>            throws IOException {<a name="line.541"></a>
<span class="sourceLineNo">542</span><a name="line.542"></a>
<span class="sourceLineNo">543</span>        // Fail fast against NullPointerException<a name="line.543"></a>
<span class="sourceLineNo">544</span>        if (canonicalParent == null) {<a name="line.544"></a>
<span class="sourceLineNo">545</span>            throw new IllegalArgumentException("Directory must not be null");<a name="line.545"></a>
<span class="sourceLineNo">546</span>        }<a name="line.546"></a>
<span class="sourceLineNo">547</span><a name="line.547"></a>
<span class="sourceLineNo">548</span>        if (canonicalChild == null) {<a name="line.548"></a>
<span class="sourceLineNo">549</span>            return false;<a name="line.549"></a>
<span class="sourceLineNo">550</span>        }<a name="line.550"></a>
<span class="sourceLineNo">551</span><a name="line.551"></a>
<span class="sourceLineNo">552</span>        if (IOCase.SYSTEM.checkEquals(canonicalParent, canonicalChild)) {<a name="line.552"></a>
<span class="sourceLineNo">553</span>            return false;<a name="line.553"></a>
<span class="sourceLineNo">554</span>        }<a name="line.554"></a>
<span class="sourceLineNo">555</span><a name="line.555"></a>
<span class="sourceLineNo">556</span>        return IOCase.SYSTEM.checkStartsWith(canonicalChild, canonicalParent);<a name="line.556"></a>
<span class="sourceLineNo">557</span>    }<a name="line.557"></a>
<span class="sourceLineNo">558</span><a name="line.558"></a>
<span class="sourceLineNo">559</span>    //-----------------------------------------------------------------------<a name="line.559"></a>
<span class="sourceLineNo">560</span>    /**<a name="line.560"></a>
<span class="sourceLineNo">561</span>     * Converts all separators to the Unix separator of forward slash.<a name="line.561"></a>
<span class="sourceLineNo">562</span>     *<a name="line.562"></a>
<span class="sourceLineNo">563</span>     * @param path  the path to be changed, null ignored<a name="line.563"></a>
<span class="sourceLineNo">564</span>     * @return the updated path<a name="line.564"></a>
<span class="sourceLineNo">565</span>     */<a name="line.565"></a>
<span class="sourceLineNo">566</span>    public static String separatorsToUnix(final String path) {<a name="line.566"></a>
<span class="sourceLineNo">567</span>        if (path == null || path.indexOf(WINDOWS_SEPARATOR) == NOT_FOUND) {<a name="line.567"></a>
<span class="sourceLineNo">568</span>            return path;<a name="line.568"></a>
<span class="sourceLineNo">569</span>        }<a name="line.569"></a>
<span class="sourceLineNo">570</span>        return path.replace(WINDOWS_SEPARATOR, UNIX_SEPARATOR);<a name="line.570"></a>
<span class="sourceLineNo">571</span>    }<a name="line.571"></a>
<span class="sourceLineNo">572</span><a name="line.572"></a>
<span class="sourceLineNo">573</span>    /**<a name="line.573"></a>
<span class="sourceLineNo">574</span>     * Converts all separators to the Windows separator of backslash.<a name="line.574"></a>
<span class="sourceLineNo">575</span>     *<a name="line.575"></a>
<span class="sourceLineNo">576</span>     * @param path  the path to be changed, null ignored<a name="line.576"></a>
<span class="sourceLineNo">577</span>     * @return the updated path<a name="line.577"></a>
<span class="sourceLineNo">578</span>     */<a name="line.578"></a>
<span class="sourceLineNo">579</span>    public static String separatorsToWindows(final String path) {<a name="line.579"></a>
<span class="sourceLineNo">580</span>        if (path == null || path.indexOf(UNIX_SEPARATOR) == NOT_FOUND) {<a name="line.580"></a>
<span class="sourceLineNo">581</span>            return path;<a name="line.581"></a>
<span class="sourceLineNo">582</span>        }<a name="line.582"></a>
<span class="sourceLineNo">583</span>        return path.replace(UNIX_SEPARATOR, WINDOWS_SEPARATOR);<a name="line.583"></a>
<span class="sourceLineNo">584</span>    }<a name="line.584"></a>
<span class="sourceLineNo">585</span><a name="line.585"></a>
<span class="sourceLineNo">586</span>    /**<a name="line.586"></a>
<span class="sourceLineNo">587</span>     * Converts all separators to the system separator.<a name="line.587"></a>
<span class="sourceLineNo">588</span>     *<a name="line.588"></a>
<span class="sourceLineNo">589</span>     * @param path  the path to be changed, null ignored<a name="line.589"></a>
<span class="sourceLineNo">590</span>     * @return the updated path<a name="line.590"></a>
<span class="sourceLineNo">591</span>     */<a name="line.591"></a>
<span class="sourceLineNo">592</span>    public static String separatorsToSystem(final String path) {<a name="line.592"></a>
<span class="sourceLineNo">593</span>        if (path == null) {<a name="line.593"></a>
<span class="sourceLineNo">594</span>            return null;<a name="line.594"></a>
<span class="sourceLineNo">595</span>        }<a name="line.595"></a>
<span class="sourceLineNo">596</span>        return isSystemWindows() ? separatorsToWindows(path) : separatorsToUnix(path);<a name="line.596"></a>
<span class="sourceLineNo">597</span>    }<a name="line.597"></a>
<span class="sourceLineNo">598</span><a name="line.598"></a>
<span class="sourceLineNo">599</span>    //-----------------------------------------------------------------------<a name="line.599"></a>
<span class="sourceLineNo">600</span>    /**<a name="line.600"></a>
<span class="sourceLineNo">601</span>     * Returns the length of the fileName prefix, such as &lt;code&gt;C:/&lt;/code&gt; or &lt;code&gt;~/&lt;/code&gt;.<a name="line.601"></a>
<span class="sourceLineNo">602</span>     * &lt;p&gt;<a name="line.602"></a>
<span class="sourceLineNo">603</span>     * This method will handle a file in either Unix or Windows format.<a name="line.603"></a>
<span class="sourceLineNo">604</span>     * &lt;p&gt;<a name="line.604"></a>
<span class="sourceLineNo">605</span>     * The prefix length includes the first slash in the full fileName<a name="line.605"></a>
<span class="sourceLineNo">606</span>     * if applicable. Thus, it is possible that the length returned is greater<a name="line.606"></a>
<span class="sourceLineNo">607</span>     * than the length of the input string.<a name="line.607"></a>
<span class="sourceLineNo">608</span>     * &lt;pre&gt;<a name="line.608"></a>
<span class="sourceLineNo">609</span>     * Windows:<a name="line.609"></a>
<span class="sourceLineNo">610</span>     * a\b\c.txt           --&amp;gt; ""          --&amp;gt; relative<a name="line.610"></a>
<span class="sourceLineNo">611</span>     * \a\b\c.txt          --&amp;gt; "\"         --&amp;gt; current drive absolute<a name="line.611"></a>
<span class="sourceLineNo">612</span>     * C:a\b\c.txt         --&amp;gt; "C:"        --&amp;gt; drive relative<a name="line.612"></a>
<span class="sourceLineNo">613</span>     * C:\a\b\c.txt        --&amp;gt; "C:\"       --&amp;gt; absolute<a name="line.613"></a>
<span class="sourceLineNo">614</span>     * \\server\a\b\c.txt  --&amp;gt; "\\server\" --&amp;gt; UNC<a name="line.614"></a>
<span class="sourceLineNo">615</span>     * \\\a\b\c.txt        --&amp;gt;  error, length = -1<a name="line.615"></a>
<span class="sourceLineNo">616</span>     *<a name="line.616"></a>
<span class="sourceLineNo">617</span>     * Unix:<a name="line.617"></a>
<span class="sourceLineNo">618</span>     * a/b/c.txt           --&amp;gt; ""          --&amp;gt; relative<a name="line.618"></a>
<span class="sourceLineNo">619</span>     * /a/b/c.txt          --&amp;gt; "/"         --&amp;gt; absolute<a name="line.619"></a>
<span class="sourceLineNo">620</span>     * ~/a/b/c.txt         --&amp;gt; "~/"        --&amp;gt; current user<a name="line.620"></a>
<span class="sourceLineNo">621</span>     * ~                   --&amp;gt; "~/"        --&amp;gt; current user (slash added)<a name="line.621"></a>
<span class="sourceLineNo">622</span>     * ~user/a/b/c.txt     --&amp;gt; "~user/"    --&amp;gt; named user<a name="line.622"></a>
<span class="sourceLineNo">623</span>     * ~user               --&amp;gt; "~user/"    --&amp;gt; named user (slash added)<a name="line.623"></a>
<span class="sourceLineNo">624</span>     * //server/a/b/c.txt  --&amp;gt; "//server/"<a name="line.624"></a>
<span class="sourceLineNo">625</span>     * ///a/b/c.txt        --&amp;gt; error, length = -1<a name="line.625"></a>
<span class="sourceLineNo">626</span>     * &lt;/pre&gt;<a name="line.626"></a>
<span class="sourceLineNo">627</span>     * &lt;p&gt;<a name="line.627"></a>
<span class="sourceLineNo">628</span>     * The output will be the same irrespective of the machine that the code is running on.<a name="line.628"></a>
<span class="sourceLineNo">629</span>     * ie. both Unix and Windows prefixes are matched regardless.<a name="line.629"></a>
<span class="sourceLineNo">630</span>     *<a name="line.630"></a>
<span class="sourceLineNo">631</span>     * Note that a leading // (or \\) is used to indicate a UNC name on Windows.<a name="line.631"></a>
<span class="sourceLineNo">632</span>     * These must be followed by a server name, so double-slashes are not collapsed<a name="line.632"></a>
<span class="sourceLineNo">633</span>     * to a single slash at the start of the fileName.<a name="line.633"></a>
<span class="sourceLineNo">634</span>     *<a name="line.634"></a>
<span class="sourceLineNo">635</span>     * @param fileName  the fileName to find the prefix in, null returns -1<a name="line.635"></a>
<span class="sourceLineNo">636</span>     * @return the length of the prefix, -1 if invalid or null<a name="line.636"></a>
<span class="sourceLineNo">637</span>     */<a name="line.637"></a>
<span class="sourceLineNo">638</span>    public static int getPrefixLength(final String fileName) {<a name="line.638"></a>
<span class="sourceLineNo">639</span>        if (fileName == null) {<a name="line.639"></a>
<span class="sourceLineNo">640</span>            return NOT_FOUND;<a name="line.640"></a>
<span class="sourceLineNo">641</span>        }<a name="line.641"></a>
<span class="sourceLineNo">642</span>        final int len = fileName.length();<a name="line.642"></a>
<span class="sourceLineNo">643</span>        if (len == 0) {<a name="line.643"></a>
<span class="sourceLineNo">644</span>            return 0;<a name="line.644"></a>
<span class="sourceLineNo">645</span>        }<a name="line.645"></a>
<span class="sourceLineNo">646</span>        char ch0 = fileName.charAt(0);<a name="line.646"></a>
<span class="sourceLineNo">647</span>        if (ch0 == ':') {<a name="line.647"></a>
<span class="sourceLineNo">648</span>            return NOT_FOUND;<a name="line.648"></a>
<span class="sourceLineNo">649</span>        }<a name="line.649"></a>
<span class="sourceLineNo">650</span>        if (len == 1) {<a name="line.650"></a>
<span class="sourceLineNo">651</span>            if (ch0 == '~') {<a name="line.651"></a>
<span class="sourceLineNo">652</span>                return 2;  // return a length greater than the input<a name="line.652"></a>
<span class="sourceLineNo">653</span>            }<a name="line.653"></a>
<span class="sourceLineNo">654</span>            return isSeparator(ch0) ? 1 : 0;<a name="line.654"></a>
<span class="sourceLineNo">655</span>        }<a name="line.655"></a>
<span class="sourceLineNo">656</span>        if (ch0 == '~') {<a name="line.656"></a>
<span class="sourceLineNo">657</span>            int posUnix = fileName.indexOf(UNIX_SEPARATOR, 1);<a name="line.657"></a>
<span class="sourceLineNo">658</span>            int posWin = fileName.indexOf(WINDOWS_SEPARATOR, 1);<a name="line.658"></a>
<span class="sourceLineNo">659</span>            if (posUnix == NOT_FOUND &amp;&amp; posWin == NOT_FOUND) {<a name="line.659"></a>
<span class="sourceLineNo">660</span>                return len + 1;  // return a length greater than the input<a name="line.660"></a>
<span class="sourceLineNo">661</span>            }<a name="line.661"></a>
<span class="sourceLineNo">662</span>            posUnix = posUnix == NOT_FOUND ? posWin : posUnix;<a name="line.662"></a>
<span class="sourceLineNo">663</span>            posWin = posWin == NOT_FOUND ? posUnix : posWin;<a name="line.663"></a>
<span class="sourceLineNo">664</span>            return Math.min(posUnix, posWin) + 1;<a name="line.664"></a>
<span class="sourceLineNo">665</span>        }<a name="line.665"></a>
<span class="sourceLineNo">666</span>        final char ch1 = fileName.charAt(1);<a name="line.666"></a>
<span class="sourceLineNo">667</span>        if (ch1 == ':') {<a name="line.667"></a>
<span class="sourceLineNo">668</span>            ch0 = Character.toUpperCase(ch0);<a name="line.668"></a>
<span class="sourceLineNo">669</span>            if (ch0 &gt;= 'A' &amp;&amp; ch0 &lt;= 'Z') {<a name="line.669"></a>
<span class="sourceLineNo">670</span>                if (len == 2 || isSeparator(fileName.charAt(2)) == false) {<a name="line.670"></a>
<span class="sourceLineNo">671</span>                    return 2;<a name="line.671"></a>
<span class="sourceLineNo">672</span>                }<a name="line.672"></a>
<span class="sourceLineNo">673</span>                return 3;<a name="line.673"></a>
<span class="sourceLineNo">674</span>            } else if (ch0 == UNIX_SEPARATOR) {<a name="line.674"></a>
<span class="sourceLineNo">675</span>                return 1;<a name="line.675"></a>
<span class="sourceLineNo">676</span>            }<a name="line.676"></a>
<span class="sourceLineNo">677</span>            return NOT_FOUND;<a name="line.677"></a>
<span class="sourceLineNo">678</span><a name="line.678"></a>
<span class="sourceLineNo">679</span>        } else if (isSeparator(ch0) &amp;&amp; isSeparator(ch1)) {<a name="line.679"></a>
<span class="sourceLineNo">680</span>            int posUnix = fileName.indexOf(UNIX_SEPARATOR, 2);<a name="line.680"></a>
<span class="sourceLineNo">681</span>            int posWin = fileName.indexOf(WINDOWS_SEPARATOR, 2);<a name="line.681"></a>
<span class="sourceLineNo">682</span>            if (posUnix == NOT_FOUND &amp;&amp; posWin == NOT_FOUND || posUnix == 2 || posWin == 2) {<a name="line.682"></a>
<span class="sourceLineNo">683</span>                return NOT_FOUND;<a name="line.683"></a>
<span class="sourceLineNo">684</span>            }<a name="line.684"></a>
<span class="sourceLineNo">685</span>            posUnix = posUnix == NOT_FOUND ? posWin : posUnix;<a name="line.685"></a>
<span class="sourceLineNo">686</span>            posWin = posWin == NOT_FOUND ? posUnix : posWin;<a name="line.686"></a>
<span class="sourceLineNo">687</span>            final int pos = Math.min(posUnix, posWin) + 1;<a name="line.687"></a>
<span class="sourceLineNo">688</span>            final String hostnamePart = fileName.substring(2, pos - 1);<a name="line.688"></a>
<span class="sourceLineNo">689</span>            return isValidHostName(hostnamePart) ? pos : NOT_FOUND;<a name="line.689"></a>
<span class="sourceLineNo">690</span>        } else {<a name="line.690"></a>
<span class="sourceLineNo">691</span>            return isSeparator(ch0) ? 1 : 0;<a name="line.691"></a>
<span class="sourceLineNo">692</span>        }<a name="line.692"></a>
<span class="sourceLineNo">693</span>    }<a name="line.693"></a>
<span class="sourceLineNo">694</span><a name="line.694"></a>
<span class="sourceLineNo">695</span>    /**<a name="line.695"></a>
<span class="sourceLineNo">696</span>     * Returns the index of the last directory separator character.<a name="line.696"></a>
<span class="sourceLineNo">697</span>     * &lt;p&gt;<a name="line.697"></a>
<span class="sourceLineNo">698</span>     * This method will handle a file in either Unix or Windows format.<a name="line.698"></a>
<span class="sourceLineNo">699</span>     * The position of the last forward or backslash is returned.<a name="line.699"></a>
<span class="sourceLineNo">700</span>     * &lt;p&gt;<a name="line.700"></a>
<span class="sourceLineNo">701</span>     * The output will be the same irrespective of the machine that the code is running on.<a name="line.701"></a>
<span class="sourceLineNo">702</span>     *<a name="line.702"></a>
<span class="sourceLineNo">703</span>     * @param fileName  the fileName to find the last path separator in, null returns -1<a name="line.703"></a>
<span class="sourceLineNo">704</span>     * @return the index of the last separator character, or -1 if there<a name="line.704"></a>
<span class="sourceLineNo">705</span>     * is no such character<a name="line.705"></a>
<span class="sourceLineNo">706</span>     */<a name="line.706"></a>
<span class="sourceLineNo">707</span>    public static int indexOfLastSeparator(final String fileName) {<a name="line.707"></a>
<span class="sourceLineNo">708</span>        if (fileName == null) {<a name="line.708"></a>
<span class="sourceLineNo">709</span>            return NOT_FOUND;<a name="line.709"></a>
<span class="sourceLineNo">710</span>        }<a name="line.710"></a>
<span class="sourceLineNo">711</span>        final int lastUnixPos = fileName.lastIndexOf(UNIX_SEPARATOR);<a name="line.711"></a>
<span class="sourceLineNo">712</span>        final int lastWindowsPos = fileName.lastIndexOf(WINDOWS_SEPARATOR);<a name="line.712"></a>
<span class="sourceLineNo">713</span>        return Math.max(lastUnixPos, lastWindowsPos);<a name="line.713"></a>
<span class="sourceLineNo">714</span>    }<a name="line.714"></a>
<span class="sourceLineNo">715</span><a name="line.715"></a>
<span class="sourceLineNo">716</span>    /**<a name="line.716"></a>
<span class="sourceLineNo">717</span>     * Returns the index of the last extension separator character, which is a dot.<a name="line.717"></a>
<span class="sourceLineNo">718</span>     * &lt;p&gt;<a name="line.718"></a>
<span class="sourceLineNo">719</span>     * This method also checks that there is no directory separator after the last dot. To do this it uses<a name="line.719"></a>
<span class="sourceLineNo">720</span>     * {@link #indexOfLastSeparator(String)} which will handle a file in either Unix or Windows format.<a name="line.720"></a>
<span class="sourceLineNo">721</span>     * &lt;/p&gt;<a name="line.721"></a>
<span class="sourceLineNo">722</span>     * &lt;p&gt;<a name="line.722"></a>
<span class="sourceLineNo">723</span>     * The output will be the same irrespective of the machine that the code is running on, with the<a name="line.723"></a>
<span class="sourceLineNo">724</span>     * exception of a possible {@link IllegalArgumentException} on Windows (see below).<a name="line.724"></a>
<span class="sourceLineNo">725</span>     * &lt;/p&gt;<a name="line.725"></a>
<span class="sourceLineNo">726</span>     * &lt;b&gt;Note:&lt;/b&gt; This method used to have a hidden problem for names like "foo.exe:bar.txt".<a name="line.726"></a>
<span class="sourceLineNo">727</span>     * In this case, the name wouldn't be the name of a file, but the identifier of an<a name="line.727"></a>
<span class="sourceLineNo">728</span>     * alternate data stream (bar.txt) on the file foo.exe. The method used to return<a name="line.728"></a>
<span class="sourceLineNo">729</span>     * ".txt" here, which would be misleading. Commons IO 2.7, and later versions, are throwing<a name="line.729"></a>
<span class="sourceLineNo">730</span>     * an {@link IllegalArgumentException} for names like this.<a name="line.730"></a>
<span class="sourceLineNo">731</span>     *<a name="line.731"></a>
<span class="sourceLineNo">732</span>     * @param fileName<a name="line.732"></a>
<span class="sourceLineNo">733</span>     *            the fileName to find the last extension separator in, null returns -1<a name="line.733"></a>
<span class="sourceLineNo">734</span>     * @return the index of the last extension separator character, or -1 if there is no such character<a name="line.734"></a>
<span class="sourceLineNo">735</span>     * @throws IllegalArgumentException &lt;b&gt;Windows only:&lt;/b&gt; The fileName parameter is, in fact,<a name="line.735"></a>
<span class="sourceLineNo">736</span>     * the identifier of an Alternate Data Stream, for example "foo.exe:bar.txt".<a name="line.736"></a>
<span class="sourceLineNo">737</span>     */<a name="line.737"></a>
<span class="sourceLineNo">738</span>    public static int indexOfExtension(final String fileName) throws IllegalArgumentException {<a name="line.738"></a>
<span class="sourceLineNo">739</span>        if (fileName == null) {<a name="line.739"></a>
<span class="sourceLineNo">740</span>            return NOT_FOUND;<a name="line.740"></a>
<span class="sourceLineNo">741</span>        }<a name="line.741"></a>
<span class="sourceLineNo">742</span>        if (isSystemWindows()) {<a name="line.742"></a>
<span class="sourceLineNo">743</span>            // Special handling for NTFS ADS: Don't accept colon in the fileName.<a name="line.743"></a>
<span class="sourceLineNo">744</span>            final int offset = fileName.indexOf(':', getAdsCriticalOffset(fileName));<a name="line.744"></a>
<span class="sourceLineNo">745</span>            if (offset != -1) {<a name="line.745"></a>
<span class="sourceLineNo">746</span>                throw new IllegalArgumentException("NTFS ADS separator (':') in file name is forbidden.");<a name="line.746"></a>
<span class="sourceLineNo">747</span>            }<a name="line.747"></a>
<span class="sourceLineNo">748</span>        }<a name="line.748"></a>
<span class="sourceLineNo">749</span>        final int extensionPos = fileName.lastIndexOf(EXTENSION_SEPARATOR);<a name="line.749"></a>
<span class="sourceLineNo">750</span>        final int lastSeparator = indexOfLastSeparator(fileName);<a name="line.750"></a>
<span class="sourceLineNo">751</span>        return lastSeparator &gt; extensionPos ? NOT_FOUND : extensionPos;<a name="line.751"></a>
<span class="sourceLineNo">752</span>    }<a name="line.752"></a>
<span class="sourceLineNo">753</span><a name="line.753"></a>
<span class="sourceLineNo">754</span>    //-----------------------------------------------------------------------<a name="line.754"></a>
<span class="sourceLineNo">755</span>    /**<a name="line.755"></a>
<span class="sourceLineNo">756</span>     * Gets the prefix from a full fileName, such as &lt;code&gt;C:/&lt;/code&gt;<a name="line.756"></a>
<span class="sourceLineNo">757</span>     * or &lt;code&gt;~/&lt;/code&gt;.<a name="line.757"></a>
<span class="sourceLineNo">758</span>     * &lt;p&gt;<a name="line.758"></a>
<span class="sourceLineNo">759</span>     * This method will handle a file in either Unix or Windows format.<a name="line.759"></a>
<span class="sourceLineNo">760</span>     * The prefix includes the first slash in the full fileName where applicable.<a name="line.760"></a>
<span class="sourceLineNo">761</span>     * &lt;pre&gt;<a name="line.761"></a>
<span class="sourceLineNo">762</span>     * Windows:<a name="line.762"></a>
<span class="sourceLineNo">763</span>     * a\b\c.txt           --&amp;gt; ""          --&amp;gt; relative<a name="line.763"></a>
<span class="sourceLineNo">764</span>     * \a\b\c.txt          --&amp;gt; "\"         --&amp;gt; current drive absolute<a name="line.764"></a>
<span class="sourceLineNo">765</span>     * C:a\b\c.txt         --&amp;gt; "C:"        --&amp;gt; drive relative<a name="line.765"></a>
<span class="sourceLineNo">766</span>     * C:\a\b\c.txt        --&amp;gt; "C:\"       --&amp;gt; absolute<a name="line.766"></a>
<span class="sourceLineNo">767</span>     * \\server\a\b\c.txt  --&amp;gt; "\\server\" --&amp;gt; UNC<a name="line.767"></a>
<span class="sourceLineNo">768</span>     *<a name="line.768"></a>
<span class="sourceLineNo">769</span>     * Unix:<a name="line.769"></a>
<span class="sourceLineNo">770</span>     * a/b/c.txt           --&amp;gt; ""          --&amp;gt; relative<a name="line.770"></a>
<span class="sourceLineNo">771</span>     * /a/b/c.txt          --&amp;gt; "/"         --&amp;gt; absolute<a name="line.771"></a>
<span class="sourceLineNo">772</span>     * ~/a/b/c.txt         --&amp;gt; "~/"        --&amp;gt; current user<a name="line.772"></a>
<span class="sourceLineNo">773</span>     * ~                   --&amp;gt; "~/"        --&amp;gt; current user (slash added)<a name="line.773"></a>
<span class="sourceLineNo">774</span>     * ~user/a/b/c.txt     --&amp;gt; "~user/"    --&amp;gt; named user<a name="line.774"></a>
<span class="sourceLineNo">775</span>     * ~user               --&amp;gt; "~user/"    --&amp;gt; named user (slash added)<a name="line.775"></a>
<span class="sourceLineNo">776</span>     * &lt;/pre&gt;<a name="line.776"></a>
<span class="sourceLineNo">777</span>     * &lt;p&gt;<a name="line.777"></a>
<span class="sourceLineNo">778</span>     * The output will be the same irrespective of the machine that the code is running on.<a name="line.778"></a>
<span class="sourceLineNo">779</span>     * ie. both Unix and Windows prefixes are matched regardless.<a name="line.779"></a>
<span class="sourceLineNo">780</span>     *<a name="line.780"></a>
<span class="sourceLineNo">781</span>     * @param fileName  the fileName to query, null returns null<a name="line.781"></a>
<span class="sourceLineNo">782</span>     * @return the prefix of the file, null if invalid. Null bytes inside string will be removed<a name="line.782"></a>
<span class="sourceLineNo">783</span>     */<a name="line.783"></a>
<span class="sourceLineNo">784</span>    public static String getPrefix(final String fileName) {<a name="line.784"></a>
<span class="sourceLineNo">785</span>        if (fileName == null) {<a name="line.785"></a>
<span class="sourceLineNo">786</span>            return null;<a name="line.786"></a>
<span class="sourceLineNo">787</span>        }<a name="line.787"></a>
<span class="sourceLineNo">788</span>        final int len = getPrefixLength(fileName);<a name="line.788"></a>
<span class="sourceLineNo">789</span>        if (len &lt; 0) {<a name="line.789"></a>
<span class="sourceLineNo">790</span>            return null;<a name="line.790"></a>
<span class="sourceLineNo">791</span>        }<a name="line.791"></a>
<span class="sourceLineNo">792</span>        if (len &gt; fileName.length()) {<a name="line.792"></a>
<span class="sourceLineNo">793</span>            failIfNullBytePresent(fileName + UNIX_SEPARATOR);<a name="line.793"></a>
<span class="sourceLineNo">794</span>            return fileName + UNIX_SEPARATOR;<a name="line.794"></a>
<span class="sourceLineNo">795</span>        }<a name="line.795"></a>
<span class="sourceLineNo">796</span>        final String path = fileName.substring(0, len);<a name="line.796"></a>
<span class="sourceLineNo">797</span>        failIfNullBytePresent(path);<a name="line.797"></a>
<span class="sourceLineNo">798</span>        return path;<a name="line.798"></a>
<span class="sourceLineNo">799</span>    }<a name="line.799"></a>
<span class="sourceLineNo">800</span><a name="line.800"></a>
<span class="sourceLineNo">801</span>    /**<a name="line.801"></a>
<span class="sourceLineNo">802</span>     * Gets the path from a full fileName, which excludes the prefix.<a name="line.802"></a>
<span class="sourceLineNo">803</span>     * &lt;p&gt;<a name="line.803"></a>
<span class="sourceLineNo">804</span>     * This method will handle a file in either Unix or Windows format.<a name="line.804"></a>
<span class="sourceLineNo">805</span>     * The method is entirely text based, and returns the text before and<a name="line.805"></a>
<span class="sourceLineNo">806</span>     * including the last forward or backslash.<a name="line.806"></a>
<span class="sourceLineNo">807</span>     * &lt;pre&gt;<a name="line.807"></a>
<span class="sourceLineNo">808</span>     * C:\a\b\c.txt --&amp;gt; a\b\<a name="line.808"></a>
<span class="sourceLineNo">809</span>     * ~/a/b/c.txt  --&amp;gt; a/b/<a name="line.809"></a>
<span class="sourceLineNo">810</span>     * a.txt        --&amp;gt; ""<a name="line.810"></a>
<span class="sourceLineNo">811</span>     * a/b/c        --&amp;gt; a/b/<a name="line.811"></a>
<span class="sourceLineNo">812</span>     * a/b/c/       --&amp;gt; a/b/c/<a name="line.812"></a>
<span class="sourceLineNo">813</span>     * &lt;/pre&gt;<a name="line.813"></a>
<span class="sourceLineNo">814</span>     * &lt;p&gt;<a name="line.814"></a>
<span class="sourceLineNo">815</span>     * The output will be the same irrespective of the machine that the code is running on.<a name="line.815"></a>
<span class="sourceLineNo">816</span>     * &lt;p&gt;<a name="line.816"></a>
<span class="sourceLineNo">817</span>     * This method drops the prefix from the result.<a name="line.817"></a>
<span class="sourceLineNo">818</span>     * See {@link #getFullPath(String)} for the method that retains the prefix.<a name="line.818"></a>
<span class="sourceLineNo">819</span>     *<a name="line.819"></a>
<span class="sourceLineNo">820</span>     * @param fileName  the fileName to query, null returns null<a name="line.820"></a>
<span class="sourceLineNo">821</span>     * @return the path of the file, an empty string if none exists, null if invalid.<a name="line.821"></a>
<span class="sourceLineNo">822</span>     * Null bytes inside string will be removed<a name="line.822"></a>
<span class="sourceLineNo">823</span>     */<a name="line.823"></a>
<span class="sourceLineNo">824</span>    public static String getPath(final String fileName) {<a name="line.824"></a>
<span class="sourceLineNo">825</span>        return doGetPath(fileName, 1);<a name="line.825"></a>
<span class="sourceLineNo">826</span>    }<a name="line.826"></a>
<span class="sourceLineNo">827</span><a name="line.827"></a>
<span class="sourceLineNo">828</span>    /**<a name="line.828"></a>
<span class="sourceLineNo">829</span>     * Gets the path from a full fileName, which excludes the prefix, and<a name="line.829"></a>
<span class="sourceLineNo">830</span>     * also excluding the final directory separator.<a name="line.830"></a>
<span class="sourceLineNo">831</span>     * &lt;p&gt;<a name="line.831"></a>
<span class="sourceLineNo">832</span>     * This method will handle a file in either Unix or Windows format.<a name="line.832"></a>
<span class="sourceLineNo">833</span>     * The method is entirely text based, and returns the text before the<a name="line.833"></a>
<span class="sourceLineNo">834</span>     * last forward or backslash.<a name="line.834"></a>
<span class="sourceLineNo">835</span>     * &lt;pre&gt;<a name="line.835"></a>
<span class="sourceLineNo">836</span>     * C:\a\b\c.txt --&amp;gt; a\b<a name="line.836"></a>
<span class="sourceLineNo">837</span>     * ~/a/b/c.txt  --&amp;gt; a/b<a name="line.837"></a>
<span class="sourceLineNo">838</span>     * a.txt        --&amp;gt; ""<a name="line.838"></a>
<span class="sourceLineNo">839</span>     * a/b/c        --&amp;gt; a/b<a name="line.839"></a>
<span class="sourceLineNo">840</span>     * a/b/c/       --&amp;gt; a/b/c<a name="line.840"></a>
<span class="sourceLineNo">841</span>     * &lt;/pre&gt;<a name="line.841"></a>
<span class="sourceLineNo">842</span>     * &lt;p&gt;<a name="line.842"></a>
<span class="sourceLineNo">843</span>     * The output will be the same irrespective of the machine that the code is running on.<a name="line.843"></a>
<span class="sourceLineNo">844</span>     * &lt;p&gt;<a name="line.844"></a>
<span class="sourceLineNo">845</span>     * This method drops the prefix from the result.<a name="line.845"></a>
<span class="sourceLineNo">846</span>     * See {@link #getFullPathNoEndSeparator(String)} for the method that retains the prefix.<a name="line.846"></a>
<span class="sourceLineNo">847</span>     *<a name="line.847"></a>
<span class="sourceLineNo">848</span>     * @param fileName  the fileName to query, null returns null<a name="line.848"></a>
<span class="sourceLineNo">849</span>     * @return the path of the file, an empty string if none exists, null if invalid.<a name="line.849"></a>
<span class="sourceLineNo">850</span>     * Null bytes inside string will be removed<a name="line.850"></a>
<span class="sourceLineNo">851</span>     */<a name="line.851"></a>
<span class="sourceLineNo">852</span>    public static String getPathNoEndSeparator(final String fileName) {<a name="line.852"></a>
<span class="sourceLineNo">853</span>        return doGetPath(fileName, 0);<a name="line.853"></a>
<span class="sourceLineNo">854</span>    }<a name="line.854"></a>
<span class="sourceLineNo">855</span><a name="line.855"></a>
<span class="sourceLineNo">856</span>    /**<a name="line.856"></a>
<span class="sourceLineNo">857</span>     * Does the work of getting the path.<a name="line.857"></a>
<span class="sourceLineNo">858</span>     *<a name="line.858"></a>
<span class="sourceLineNo">859</span>     * @param fileName  the fileName<a name="line.859"></a>
<span class="sourceLineNo">860</span>     * @param separatorAdd  0 to omit the end separator, 1 to return it<a name="line.860"></a>
<span class="sourceLineNo">861</span>     * @return the path. Null bytes inside string will be removed<a name="line.861"></a>
<span class="sourceLineNo">862</span>     */<a name="line.862"></a>
<span class="sourceLineNo">863</span>    private static String doGetPath(final String fileName, final int separatorAdd) {<a name="line.863"></a>
<span class="sourceLineNo">864</span>        if (fileName == null) {<a name="line.864"></a>
<span class="sourceLineNo">865</span>            return null;<a name="line.865"></a>
<span class="sourceLineNo">866</span>        }<a name="line.866"></a>
<span class="sourceLineNo">867</span>        final int prefix = getPrefixLength(fileName);<a name="line.867"></a>
<span class="sourceLineNo">868</span>        if (prefix &lt; 0) {<a name="line.868"></a>
<span class="sourceLineNo">869</span>            return null;<a name="line.869"></a>
<span class="sourceLineNo">870</span>        }<a name="line.870"></a>
<span class="sourceLineNo">871</span>        final int index = indexOfLastSeparator(fileName);<a name="line.871"></a>
<span class="sourceLineNo">872</span>        final int endIndex = index+separatorAdd;<a name="line.872"></a>
<span class="sourceLineNo">873</span>        if (prefix &gt;= fileName.length() || index &lt; 0 || prefix &gt;= endIndex) {<a name="line.873"></a>
<span class="sourceLineNo">874</span>            return EMPTY_STRING;<a name="line.874"></a>
<span class="sourceLineNo">875</span>        }<a name="line.875"></a>
<span class="sourceLineNo">876</span>        final String path = fileName.substring(prefix, endIndex);<a name="line.876"></a>
<span class="sourceLineNo">877</span>        failIfNullBytePresent(path);<a name="line.877"></a>
<span class="sourceLineNo">878</span>        return path;<a name="line.878"></a>
<span class="sourceLineNo">879</span>    }<a name="line.879"></a>
<span class="sourceLineNo">880</span><a name="line.880"></a>
<span class="sourceLineNo">881</span>    /**<a name="line.881"></a>
<span class="sourceLineNo">882</span>     * Gets the full path from a full fileName, which is the prefix + path.<a name="line.882"></a>
<span class="sourceLineNo">883</span>     * &lt;p&gt;<a name="line.883"></a>
<span class="sourceLineNo">884</span>     * This method will handle a file in either Unix or Windows format.<a name="line.884"></a>
<span class="sourceLineNo">885</span>     * The method is entirely text based, and returns the text before and<a name="line.885"></a>
<span class="sourceLineNo">886</span>     * including the last forward or backslash.<a name="line.886"></a>
<span class="sourceLineNo">887</span>     * &lt;pre&gt;<a name="line.887"></a>
<span class="sourceLineNo">888</span>     * C:\a\b\c.txt --&amp;gt; C:\a\b\<a name="line.888"></a>
<span class="sourceLineNo">889</span>     * ~/a/b/c.txt  --&amp;gt; ~/a/b/<a name="line.889"></a>
<span class="sourceLineNo">890</span>     * a.txt        --&amp;gt; ""<a name="line.890"></a>
<span class="sourceLineNo">891</span>     * a/b/c        --&amp;gt; a/b/<a name="line.891"></a>
<span class="sourceLineNo">892</span>     * a/b/c/       --&amp;gt; a/b/c/<a name="line.892"></a>
<span class="sourceLineNo">893</span>     * C:           --&amp;gt; C:<a name="line.893"></a>
<span class="sourceLineNo">894</span>     * C:\          --&amp;gt; C:\<a name="line.894"></a>
<span class="sourceLineNo">895</span>     * ~            --&amp;gt; ~/<a name="line.895"></a>
<span class="sourceLineNo">896</span>     * ~/           --&amp;gt; ~/<a name="line.896"></a>
<span class="sourceLineNo">897</span>     * ~user        --&amp;gt; ~user/<a name="line.897"></a>
<span class="sourceLineNo">898</span>     * ~user/       --&amp;gt; ~user/<a name="line.898"></a>
<span class="sourceLineNo">899</span>     * &lt;/pre&gt;<a name="line.899"></a>
<span class="sourceLineNo">900</span>     * &lt;p&gt;<a name="line.900"></a>
<span class="sourceLineNo">901</span>     * The output will be the same irrespective of the machine that the code is running on.<a name="line.901"></a>
<span class="sourceLineNo">902</span>     *<a name="line.902"></a>
<span class="sourceLineNo">903</span>     * @param fileName  the fileName to query, null returns null<a name="line.903"></a>
<span class="sourceLineNo">904</span>     * @return the path of the file, an empty string if none exists, null if invalid<a name="line.904"></a>
<span class="sourceLineNo">905</span>     */<a name="line.905"></a>
<span class="sourceLineNo">906</span>    public static String getFullPath(final String fileName) {<a name="line.906"></a>
<span class="sourceLineNo">907</span>        return doGetFullPath(fileName, true);<a name="line.907"></a>
<span class="sourceLineNo">908</span>    }<a name="line.908"></a>
<span class="sourceLineNo">909</span><a name="line.909"></a>
<span class="sourceLineNo">910</span>    /**<a name="line.910"></a>
<span class="sourceLineNo">911</span>     * Gets the full path from a full fileName, which is the prefix + path,<a name="line.911"></a>
<span class="sourceLineNo">912</span>     * and also excluding the final directory separator.<a name="line.912"></a>
<span class="sourceLineNo">913</span>     * &lt;p&gt;<a name="line.913"></a>
<span class="sourceLineNo">914</span>     * This method will handle a file in either Unix or Windows format.<a name="line.914"></a>
<span class="sourceLineNo">915</span>     * The method is entirely text based, and returns the text before the<a name="line.915"></a>
<span class="sourceLineNo">916</span>     * last forward or backslash.<a name="line.916"></a>
<span class="sourceLineNo">917</span>     * &lt;pre&gt;<a name="line.917"></a>
<span class="sourceLineNo">918</span>     * C:\a\b\c.txt --&amp;gt; C:\a\b<a name="line.918"></a>
<span class="sourceLineNo">919</span>     * ~/a/b/c.txt  --&amp;gt; ~/a/b<a name="line.919"></a>
<span class="sourceLineNo">920</span>     * a.txt        --&amp;gt; ""<a name="line.920"></a>
<span class="sourceLineNo">921</span>     * a/b/c        --&amp;gt; a/b<a name="line.921"></a>
<span class="sourceLineNo">922</span>     * a/b/c/       --&amp;gt; a/b/c<a name="line.922"></a>
<span class="sourceLineNo">923</span>     * C:           --&amp;gt; C:<a name="line.923"></a>
<span class="sourceLineNo">924</span>     * C:\          --&amp;gt; C:\<a name="line.924"></a>
<span class="sourceLineNo">925</span>     * ~            --&amp;gt; ~<a name="line.925"></a>
<span class="sourceLineNo">926</span>     * ~/           --&amp;gt; ~<a name="line.926"></a>
<span class="sourceLineNo">927</span>     * ~user        --&amp;gt; ~user<a name="line.927"></a>
<span class="sourceLineNo">928</span>     * ~user/       --&amp;gt; ~user<a name="line.928"></a>
<span class="sourceLineNo">929</span>     * &lt;/pre&gt;<a name="line.929"></a>
<span class="sourceLineNo">930</span>     * &lt;p&gt;<a name="line.930"></a>
<span class="sourceLineNo">931</span>     * The output will be the same irrespective of the machine that the code is running on.<a name="line.931"></a>
<span class="sourceLineNo">932</span>     *<a name="line.932"></a>
<span class="sourceLineNo">933</span>     * @param fileName  the fileName to query, null returns null<a name="line.933"></a>
<span class="sourceLineNo">934</span>     * @return the path of the file, an empty string if none exists, null if invalid<a name="line.934"></a>
<span class="sourceLineNo">935</span>     */<a name="line.935"></a>
<span class="sourceLineNo">936</span>    public static String getFullPathNoEndSeparator(final String fileName) {<a name="line.936"></a>
<span class="sourceLineNo">937</span>        return doGetFullPath(fileName, false);<a name="line.937"></a>
<span class="sourceLineNo">938</span>    }<a name="line.938"></a>
<span class="sourceLineNo">939</span><a name="line.939"></a>
<span class="sourceLineNo">940</span>    /**<a name="line.940"></a>
<span class="sourceLineNo">941</span>     * Does the work of getting the path.<a name="line.941"></a>
<span class="sourceLineNo">942</span>     *<a name="line.942"></a>
<span class="sourceLineNo">943</span>     * @param fileName  the fileName<a name="line.943"></a>
<span class="sourceLineNo">944</span>     * @param includeSeparator  true to include the end separator<a name="line.944"></a>
<span class="sourceLineNo">945</span>     * @return the path<a name="line.945"></a>
<span class="sourceLineNo">946</span>     */<a name="line.946"></a>
<span class="sourceLineNo">947</span>    private static String doGetFullPath(final String fileName, final boolean includeSeparator) {<a name="line.947"></a>
<span class="sourceLineNo">948</span>        if (fileName == null) {<a name="line.948"></a>
<span class="sourceLineNo">949</span>            return null;<a name="line.949"></a>
<span class="sourceLineNo">950</span>        }<a name="line.950"></a>
<span class="sourceLineNo">951</span>        final int prefix = getPrefixLength(fileName);<a name="line.951"></a>
<span class="sourceLineNo">952</span>        if (prefix &lt; 0) {<a name="line.952"></a>
<span class="sourceLineNo">953</span>            return null;<a name="line.953"></a>
<span class="sourceLineNo">954</span>        }<a name="line.954"></a>
<span class="sourceLineNo">955</span>        if (prefix &gt;= fileName.length()) {<a name="line.955"></a>
<span class="sourceLineNo">956</span>            if (includeSeparator) {<a name="line.956"></a>
<span class="sourceLineNo">957</span>                return getPrefix(fileName);  // add end slash if necessary<a name="line.957"></a>
<span class="sourceLineNo">958</span>            }<a name="line.958"></a>
<span class="sourceLineNo">959</span>            return fileName;<a name="line.959"></a>
<span class="sourceLineNo">960</span>        }<a name="line.960"></a>
<span class="sourceLineNo">961</span>        final int index = indexOfLastSeparator(fileName);<a name="line.961"></a>
<span class="sourceLineNo">962</span>        if (index &lt; 0) {<a name="line.962"></a>
<span class="sourceLineNo">963</span>            return fileName.substring(0, prefix);<a name="line.963"></a>
<span class="sourceLineNo">964</span>        }<a name="line.964"></a>
<span class="sourceLineNo">965</span>        int end = index + (includeSeparator ?  1 : 0);<a name="line.965"></a>
<span class="sourceLineNo">966</span>        if (end == 0) {<a name="line.966"></a>
<span class="sourceLineNo">967</span>            end++;<a name="line.967"></a>
<span class="sourceLineNo">968</span>        }<a name="line.968"></a>
<span class="sourceLineNo">969</span>        return fileName.substring(0, end);<a name="line.969"></a>
<span class="sourceLineNo">970</span>    }<a name="line.970"></a>
<span class="sourceLineNo">971</span><a name="line.971"></a>
<span class="sourceLineNo">972</span>    /**<a name="line.972"></a>
<span class="sourceLineNo">973</span>     * Gets the name minus the path from a full fileName.<a name="line.973"></a>
<span class="sourceLineNo">974</span>     * &lt;p&gt;<a name="line.974"></a>
<span class="sourceLineNo">975</span>     * This method will handle a file in either Unix or Windows format.<a name="line.975"></a>
<span class="sourceLineNo">976</span>     * The text after the last forward or backslash is returned.<a name="line.976"></a>
<span class="sourceLineNo">977</span>     * &lt;pre&gt;<a name="line.977"></a>
<span class="sourceLineNo">978</span>     * a/b/c.txt --&amp;gt; c.txt<a name="line.978"></a>
<span class="sourceLineNo">979</span>     * a.txt     --&amp;gt; a.txt<a name="line.979"></a>
<span class="sourceLineNo">980</span>     * a/b/c     --&amp;gt; c<a name="line.980"></a>
<span class="sourceLineNo">981</span>     * a/b/c/    --&amp;gt; ""<a name="line.981"></a>
<span class="sourceLineNo">982</span>     * &lt;/pre&gt;<a name="line.982"></a>
<span class="sourceLineNo">983</span>     * &lt;p&gt;<a name="line.983"></a>
<span class="sourceLineNo">984</span>     * The output will be the same irrespective of the machine that the code is running on.<a name="line.984"></a>
<span class="sourceLineNo">985</span>     *<a name="line.985"></a>
<span class="sourceLineNo">986</span>     * @param fileName  the fileName to query, null returns null<a name="line.986"></a>
<span class="sourceLineNo">987</span>     * @return the name of the file without the path, or an empty string if none exists.<a name="line.987"></a>
<span class="sourceLineNo">988</span>     * Null bytes inside string will be removed<a name="line.988"></a>
<span class="sourceLineNo">989</span>     */<a name="line.989"></a>
<span class="sourceLineNo">990</span>    public static String getName(final String fileName) {<a name="line.990"></a>
<span class="sourceLineNo">991</span>        if (fileName == null) {<a name="line.991"></a>
<span class="sourceLineNo">992</span>            return null;<a name="line.992"></a>
<span class="sourceLineNo">993</span>        }<a name="line.993"></a>
<span class="sourceLineNo">994</span>        failIfNullBytePresent(fileName);<a name="line.994"></a>
<span class="sourceLineNo">995</span>        final int index = indexOfLastSeparator(fileName);<a name="line.995"></a>
<span class="sourceLineNo">996</span>        return fileName.substring(index + 1);<a name="line.996"></a>
<span class="sourceLineNo">997</span>    }<a name="line.997"></a>
<span class="sourceLineNo">998</span><a name="line.998"></a>
<span class="sourceLineNo">999</span>    /**<a name="line.999"></a>
<span class="sourceLineNo">1000</span>     * Check the input for null bytes, a sign of unsanitized data being passed to to file level functions.<a name="line.1000"></a>
<span class="sourceLineNo">1001</span>     *<a name="line.1001"></a>
<span class="sourceLineNo">1002</span>     * This may be used for poison byte attacks.<a name="line.1002"></a>
<span class="sourceLineNo">1003</span>     * @param path the path to check<a name="line.1003"></a>
<span class="sourceLineNo">1004</span>     */<a name="line.1004"></a>
<span class="sourceLineNo">1005</span>    private static void failIfNullBytePresent(final String path) {<a name="line.1005"></a>
<span class="sourceLineNo">1006</span>        final int len = path.length();<a name="line.1006"></a>
<span class="sourceLineNo">1007</span>        for (int i = 0; i &lt; len; i++) {<a name="line.1007"></a>
<span class="sourceLineNo">1008</span>            if (path.charAt(i) == 0) {<a name="line.1008"></a>
<span class="sourceLineNo">1009</span>                throw new IllegalArgumentException("Null byte present in file/path name. There are no " +<a name="line.1009"></a>
<span class="sourceLineNo">1010</span>                        "known legitimate use cases for such data, but several injection attacks may use it");<a name="line.1010"></a>
<span class="sourceLineNo">1011</span>            }<a name="line.1011"></a>
<span class="sourceLineNo">1012</span>        }<a name="line.1012"></a>
<span class="sourceLineNo">1013</span>    }<a name="line.1013"></a>
<span class="sourceLineNo">1014</span><a name="line.1014"></a>
<span class="sourceLineNo">1015</span>    /**<a name="line.1015"></a>
<span class="sourceLineNo">1016</span>     * Gets the base name, minus the full path and extension, from a full fileName.<a name="line.1016"></a>
<span class="sourceLineNo">1017</span>     * &lt;p&gt;<a name="line.1017"></a>
<span class="sourceLineNo">1018</span>     * This method will handle a file in either Unix or Windows format.<a name="line.1018"></a>
<span class="sourceLineNo">1019</span>     * The text after the last forward or backslash and before the last dot is returned.<a name="line.1019"></a>
<span class="sourceLineNo">1020</span>     * &lt;pre&gt;<a name="line.1020"></a>
<span class="sourceLineNo">1021</span>     * a/b/c.txt --&amp;gt; c<a name="line.1021"></a>
<span class="sourceLineNo">1022</span>     * a.txt     --&amp;gt; a<a name="line.1022"></a>
<span class="sourceLineNo">1023</span>     * a/b/c     --&amp;gt; c<a name="line.1023"></a>
<span class="sourceLineNo">1024</span>     * a/b/c/    --&amp;gt; ""<a name="line.1024"></a>
<span class="sourceLineNo">1025</span>     * &lt;/pre&gt;<a name="line.1025"></a>
<span class="sourceLineNo">1026</span>     * &lt;p&gt;<a name="line.1026"></a>
<span class="sourceLineNo">1027</span>     * The output will be the same irrespective of the machine that the code is running on.<a name="line.1027"></a>
<span class="sourceLineNo">1028</span>     *<a name="line.1028"></a>
<span class="sourceLineNo">1029</span>     * @param fileName  the fileName to query, null returns null<a name="line.1029"></a>
<span class="sourceLineNo">1030</span>     * @return the name of the file without the path, or an empty string if none exists. Null bytes inside string<a name="line.1030"></a>
<span class="sourceLineNo">1031</span>     * will be removed<a name="line.1031"></a>
<span class="sourceLineNo">1032</span>     */<a name="line.1032"></a>
<span class="sourceLineNo">1033</span>    public static String getBaseName(final String fileName) {<a name="line.1033"></a>
<span class="sourceLineNo">1034</span>        return removeExtension(getName(fileName));<a name="line.1034"></a>
<span class="sourceLineNo">1035</span>    }<a name="line.1035"></a>
<span class="sourceLineNo">1036</span><a name="line.1036"></a>
<span class="sourceLineNo">1037</span>    /**<a name="line.1037"></a>
<span class="sourceLineNo">1038</span>     * Gets the extension of a fileName.<a name="line.1038"></a>
<span class="sourceLineNo">1039</span>     * &lt;p&gt;<a name="line.1039"></a>
<span class="sourceLineNo">1040</span>     * This method returns the textual part of the fileName after the last dot.<a name="line.1040"></a>
<span class="sourceLineNo">1041</span>     * There must be no directory separator after the dot.<a name="line.1041"></a>
<span class="sourceLineNo">1042</span>     * &lt;pre&gt;<a name="line.1042"></a>
<span class="sourceLineNo">1043</span>     * foo.txt      --&amp;gt; "txt"<a name="line.1043"></a>
<span class="sourceLineNo">1044</span>     * a/b/c.jpg    --&amp;gt; "jpg"<a name="line.1044"></a>
<span class="sourceLineNo">1045</span>     * a/b.txt/c    --&amp;gt; ""<a name="line.1045"></a>
<span class="sourceLineNo">1046</span>     * a/b/c        --&amp;gt; ""<a name="line.1046"></a>
<span class="sourceLineNo">1047</span>     * &lt;/pre&gt;<a name="line.1047"></a>
<span class="sourceLineNo">1048</span>     * &lt;p&gt;<a name="line.1048"></a>
<span class="sourceLineNo">1049</span>     * The output will be the same irrespective of the machine that the code is running on, with the<a name="line.1049"></a>
<span class="sourceLineNo">1050</span>     * exception of a possible {@link IllegalArgumentException} on Windows (see below).<a name="line.1050"></a>
<span class="sourceLineNo">1051</span>     * &lt;/p&gt;<a name="line.1051"></a>
<span class="sourceLineNo">1052</span>     * &lt;p&gt;<a name="line.1052"></a>
<span class="sourceLineNo">1053</span>     * &lt;b&gt;Note:&lt;/b&gt; This method used to have a hidden problem for names like "foo.exe:bar.txt".<a name="line.1053"></a>
<span class="sourceLineNo">1054</span>     * In this case, the name wouldn't be the name of a file, but the identifier of an<a name="line.1054"></a>
<span class="sourceLineNo">1055</span>     * alternate data stream (bar.txt) on the file foo.exe. The method used to return<a name="line.1055"></a>
<span class="sourceLineNo">1056</span>     * ".txt" here, which would be misleading. Commons IO 2.7, and later versions, are throwing<a name="line.1056"></a>
<span class="sourceLineNo">1057</span>     * an {@link IllegalArgumentException} for names like this.<a name="line.1057"></a>
<span class="sourceLineNo">1058</span>     *<a name="line.1058"></a>
<span class="sourceLineNo">1059</span>     * @param fileName the fileName to retrieve the extension of.<a name="line.1059"></a>
<span class="sourceLineNo">1060</span>     * @return the extension of the file or an empty string if none exists or {@code null}<a name="line.1060"></a>
<span class="sourceLineNo">1061</span>     * if the fileName is {@code null}.<a name="line.1061"></a>
<span class="sourceLineNo">1062</span>     * @throws IllegalArgumentException &lt;b&gt;Windows only:&lt;/b&gt; The fileName parameter is, in fact,<a name="line.1062"></a>
<span class="sourceLineNo">1063</span>     * the identifier of an Alternate Data Stream, for example "foo.exe:bar.txt".<a name="line.1063"></a>
<span class="sourceLineNo">1064</span>     */<a name="line.1064"></a>
<span class="sourceLineNo">1065</span>    public static String getExtension(final String fileName) throws IllegalArgumentException {<a name="line.1065"></a>
<span class="sourceLineNo">1066</span>        if (fileName == null) {<a name="line.1066"></a>
<span class="sourceLineNo">1067</span>            return null;<a name="line.1067"></a>
<span class="sourceLineNo">1068</span>        }<a name="line.1068"></a>
<span class="sourceLineNo">1069</span>        final int index = indexOfExtension(fileName);<a name="line.1069"></a>
<span class="sourceLineNo">1070</span>        if (index == NOT_FOUND) {<a name="line.1070"></a>
<span class="sourceLineNo">1071</span>            return EMPTY_STRING;<a name="line.1071"></a>
<span class="sourceLineNo">1072</span>        }<a name="line.1072"></a>
<span class="sourceLineNo">1073</span>        return fileName.substring(index + 1);<a name="line.1073"></a>
<span class="sourceLineNo">1074</span>    }<a name="line.1074"></a>
<span class="sourceLineNo">1075</span><a name="line.1075"></a>
<span class="sourceLineNo">1076</span>    /**<a name="line.1076"></a>
<span class="sourceLineNo">1077</span>     * Special handling for NTFS ADS: Don't accept colon in the fileName.<a name="line.1077"></a>
<span class="sourceLineNo">1078</span>     *<a name="line.1078"></a>
<span class="sourceLineNo">1079</span>     * @param fileName a file name<a name="line.1079"></a>
<span class="sourceLineNo">1080</span>     * @return ADS offsets.<a name="line.1080"></a>
<span class="sourceLineNo">1081</span>     */<a name="line.1081"></a>
<span class="sourceLineNo">1082</span>    private static int getAdsCriticalOffset(final String fileName) {<a name="line.1082"></a>
<span class="sourceLineNo">1083</span>        // Step 1: Remove leading path segments.<a name="line.1083"></a>
<span class="sourceLineNo">1084</span>        final int offset1 = fileName.lastIndexOf(SYSTEM_SEPARATOR);<a name="line.1084"></a>
<span class="sourceLineNo">1085</span>        final int offset2 = fileName.lastIndexOf(OTHER_SEPARATOR);<a name="line.1085"></a>
<span class="sourceLineNo">1086</span>        if (offset1 == -1) {<a name="line.1086"></a>
<span class="sourceLineNo">1087</span>            if (offset2 == -1) {<a name="line.1087"></a>
<span class="sourceLineNo">1088</span>                return 0;<a name="line.1088"></a>
<span class="sourceLineNo">1089</span>            }<a name="line.1089"></a>
<span class="sourceLineNo">1090</span>            return offset2 + 1;<a name="line.1090"></a>
<span class="sourceLineNo">1091</span>        }<a name="line.1091"></a>
<span class="sourceLineNo">1092</span>        if (offset2 == -1) {<a name="line.1092"></a>
<span class="sourceLineNo">1093</span>            return offset1 + 1;<a name="line.1093"></a>
<span class="sourceLineNo">1094</span>        }<a name="line.1094"></a>
<span class="sourceLineNo">1095</span>        return Math.max(offset1, offset2) + 1;<a name="line.1095"></a>
<span class="sourceLineNo">1096</span>    }<a name="line.1096"></a>
<span class="sourceLineNo">1097</span><a name="line.1097"></a>
<span class="sourceLineNo">1098</span>    //-----------------------------------------------------------------------<a name="line.1098"></a>
<span class="sourceLineNo">1099</span>    /**<a name="line.1099"></a>
<span class="sourceLineNo">1100</span>     * Removes the extension from a fileName.<a name="line.1100"></a>
<span class="sourceLineNo">1101</span>     * &lt;p&gt;<a name="line.1101"></a>
<span class="sourceLineNo">1102</span>     * This method returns the textual part of the fileName before the last dot.<a name="line.1102"></a>
<span class="sourceLineNo">1103</span>     * There must be no directory separator after the dot.<a name="line.1103"></a>
<span class="sourceLineNo">1104</span>     * &lt;pre&gt;<a name="line.1104"></a>
<span class="sourceLineNo">1105</span>     * foo.txt    --&amp;gt; foo<a name="line.1105"></a>
<span class="sourceLineNo">1106</span>     * a\b\c.jpg  --&amp;gt; a\b\c<a name="line.1106"></a>
<span class="sourceLineNo">1107</span>     * a\b\c      --&amp;gt; a\b\c<a name="line.1107"></a>
<span class="sourceLineNo">1108</span>     * a.b\c      --&amp;gt; a.b\c<a name="line.1108"></a>
<span class="sourceLineNo">1109</span>     * &lt;/pre&gt;<a name="line.1109"></a>
<span class="sourceLineNo">1110</span>     * &lt;p&gt;<a name="line.1110"></a>
<span class="sourceLineNo">1111</span>     * The output will be the same irrespective of the machine that the code is running on.<a name="line.1111"></a>
<span class="sourceLineNo">1112</span>     *<a name="line.1112"></a>
<span class="sourceLineNo">1113</span>     * @param fileName  the fileName to query, null returns null<a name="line.1113"></a>
<span class="sourceLineNo">1114</span>     * @return the fileName minus the extension<a name="line.1114"></a>
<span class="sourceLineNo">1115</span>     */<a name="line.1115"></a>
<span class="sourceLineNo">1116</span>    public static String removeExtension(final String fileName) {<a name="line.1116"></a>
<span class="sourceLineNo">1117</span>        if (fileName == null) {<a name="line.1117"></a>
<span class="sourceLineNo">1118</span>            return null;<a name="line.1118"></a>
<span class="sourceLineNo">1119</span>        }<a name="line.1119"></a>
<span class="sourceLineNo">1120</span>        failIfNullBytePresent(fileName);<a name="line.1120"></a>
<span class="sourceLineNo">1121</span><a name="line.1121"></a>
<span class="sourceLineNo">1122</span>        final int index = indexOfExtension(fileName);<a name="line.1122"></a>
<span class="sourceLineNo">1123</span>        if (index == NOT_FOUND) {<a name="line.1123"></a>
<span class="sourceLineNo">1124</span>            return fileName;<a name="line.1124"></a>
<span class="sourceLineNo">1125</span>        }<a name="line.1125"></a>
<span class="sourceLineNo">1126</span>        return fileName.substring(0, index);<a name="line.1126"></a>
<span class="sourceLineNo">1127</span>    }<a name="line.1127"></a>
<span class="sourceLineNo">1128</span><a name="line.1128"></a>
<span class="sourceLineNo">1129</span>    //-----------------------------------------------------------------------<a name="line.1129"></a>
<span class="sourceLineNo">1130</span>    /**<a name="line.1130"></a>
<span class="sourceLineNo">1131</span>     * Checks whether two fileNames are equal exactly.<a name="line.1131"></a>
<span class="sourceLineNo">1132</span>     * &lt;p&gt;<a name="line.1132"></a>
<span class="sourceLineNo">1133</span>     * No processing is performed on the fileNames other than comparison,<a name="line.1133"></a>
<span class="sourceLineNo">1134</span>     * thus this is merely a null-safe case-sensitive equals.<a name="line.1134"></a>
<span class="sourceLineNo">1135</span>     *<a name="line.1135"></a>
<span class="sourceLineNo">1136</span>     * @param fileName1  the first fileName to query, may be null<a name="line.1136"></a>
<span class="sourceLineNo">1137</span>     * @param fileName2  the second fileName to query, may be null<a name="line.1137"></a>
<span class="sourceLineNo">1138</span>     * @return true if the fileNames are equal, null equals null<a name="line.1138"></a>
<span class="sourceLineNo">1139</span>     * @see IOCase#SENSITIVE<a name="line.1139"></a>
<span class="sourceLineNo">1140</span>     */<a name="line.1140"></a>
<span class="sourceLineNo">1141</span>    public static boolean equals(final String fileName1, final String fileName2) {<a name="line.1141"></a>
<span class="sourceLineNo">1142</span>        return equals(fileName1, fileName2, false, IOCase.SENSITIVE);<a name="line.1142"></a>
<span class="sourceLineNo">1143</span>    }<a name="line.1143"></a>
<span class="sourceLineNo">1144</span><a name="line.1144"></a>
<span class="sourceLineNo">1145</span>    /**<a name="line.1145"></a>
<span class="sourceLineNo">1146</span>     * Checks whether two fileNames are equal using the case rules of the system.<a name="line.1146"></a>
<span class="sourceLineNo">1147</span>     * &lt;p&gt;<a name="line.1147"></a>
<span class="sourceLineNo">1148</span>     * No processing is performed on the fileNames other than comparison.<a name="line.1148"></a>
<span class="sourceLineNo">1149</span>     * The check is case-sensitive on Unix and case-insensitive on Windows.<a name="line.1149"></a>
<span class="sourceLineNo">1150</span>     *<a name="line.1150"></a>
<span class="sourceLineNo">1151</span>     * @param fileName1  the first fileName to query, may be null<a name="line.1151"></a>
<span class="sourceLineNo">1152</span>     * @param fileName2  the second fileName to query, may be null<a name="line.1152"></a>
<span class="sourceLineNo">1153</span>     * @return true if the fileNames are equal, null equals null<a name="line.1153"></a>
<span class="sourceLineNo">1154</span>     * @see IOCase#SYSTEM<a name="line.1154"></a>
<span class="sourceLineNo">1155</span>     */<a name="line.1155"></a>
<span class="sourceLineNo">1156</span>    public static boolean equalsOnSystem(final String fileName1, final String fileName2) {<a name="line.1156"></a>
<span class="sourceLineNo">1157</span>        return equals(fileName1, fileName2, false, IOCase.SYSTEM);<a name="line.1157"></a>
<span class="sourceLineNo">1158</span>    }<a name="line.1158"></a>
<span class="sourceLineNo">1159</span><a name="line.1159"></a>
<span class="sourceLineNo">1160</span>    //-----------------------------------------------------------------------<a name="line.1160"></a>
<span class="sourceLineNo">1161</span>    /**<a name="line.1161"></a>
<span class="sourceLineNo">1162</span>     * Checks whether two fileNames are equal after both have been normalized.<a name="line.1162"></a>
<span class="sourceLineNo">1163</span>     * &lt;p&gt;<a name="line.1163"></a>
<span class="sourceLineNo">1164</span>     * Both fileNames are first passed to {@link #normalize(String)}.<a name="line.1164"></a>
<span class="sourceLineNo">1165</span>     * The check is then performed in a case-sensitive manner.<a name="line.1165"></a>
<span class="sourceLineNo">1166</span>     *<a name="line.1166"></a>
<span class="sourceLineNo">1167</span>     * @param fileName1  the first fileName to query, may be null<a name="line.1167"></a>
<span class="sourceLineNo">1168</span>     * @param fileName2  the second fileName to query, may be null<a name="line.1168"></a>
<span class="sourceLineNo">1169</span>     * @return true if the fileNames are equal, null equals null<a name="line.1169"></a>
<span class="sourceLineNo">1170</span>     * @see IOCase#SENSITIVE<a name="line.1170"></a>
<span class="sourceLineNo">1171</span>     */<a name="line.1171"></a>
<span class="sourceLineNo">1172</span>    public static boolean equalsNormalized(final String fileName1, final String fileName2) {<a name="line.1172"></a>
<span class="sourceLineNo">1173</span>        return equals(fileName1, fileName2, true, IOCase.SENSITIVE);<a name="line.1173"></a>
<span class="sourceLineNo">1174</span>    }<a name="line.1174"></a>
<span class="sourceLineNo">1175</span><a name="line.1175"></a>
<span class="sourceLineNo">1176</span>    /**<a name="line.1176"></a>
<span class="sourceLineNo">1177</span>     * Checks whether two fileNames are equal after both have been normalized<a name="line.1177"></a>
<span class="sourceLineNo">1178</span>     * and using the case rules of the system.<a name="line.1178"></a>
<span class="sourceLineNo">1179</span>     * &lt;p&gt;<a name="line.1179"></a>
<span class="sourceLineNo">1180</span>     * Both fileNames are first passed to {@link #normalize(String)}.<a name="line.1180"></a>
<span class="sourceLineNo">1181</span>     * The check is then performed case-sensitive on Unix and<a name="line.1181"></a>
<span class="sourceLineNo">1182</span>     * case-insensitive on Windows.<a name="line.1182"></a>
<span class="sourceLineNo">1183</span>     *<a name="line.1183"></a>
<span class="sourceLineNo">1184</span>     * @param fileName1  the first fileName to query, may be null<a name="line.1184"></a>
<span class="sourceLineNo">1185</span>     * @param fileName2  the second fileName to query, may be null<a name="line.1185"></a>
<span class="sourceLineNo">1186</span>     * @return true if the fileNames are equal, null equals null<a name="line.1186"></a>
<span class="sourceLineNo">1187</span>     * @see IOCase#SYSTEM<a name="line.1187"></a>
<span class="sourceLineNo">1188</span>     */<a name="line.1188"></a>
<span class="sourceLineNo">1189</span>    public static boolean equalsNormalizedOnSystem(final String fileName1, final String fileName2) {<a name="line.1189"></a>
<span class="sourceLineNo">1190</span>        return equals(fileName1, fileName2, true, IOCase.SYSTEM);<a name="line.1190"></a>
<span class="sourceLineNo">1191</span>    }<a name="line.1191"></a>
<span class="sourceLineNo">1192</span><a name="line.1192"></a>
<span class="sourceLineNo">1193</span>    /**<a name="line.1193"></a>
<span class="sourceLineNo">1194</span>     * Checks whether two fileNames are equal, optionally normalizing and providing<a name="line.1194"></a>
<span class="sourceLineNo">1195</span>     * control over the case-sensitivity.<a name="line.1195"></a>
<span class="sourceLineNo">1196</span>     *<a name="line.1196"></a>
<span class="sourceLineNo">1197</span>     * @param fileName1  the first fileName to query, may be null<a name="line.1197"></a>
<span class="sourceLineNo">1198</span>     * @param fileName2  the second fileName to query, may be null<a name="line.1198"></a>
<span class="sourceLineNo">1199</span>     * @param normalized  whether to normalize the fileNames<a name="line.1199"></a>
<span class="sourceLineNo">1200</span>     * @param caseSensitivity  what case sensitivity rule to use, null means case-sensitive<a name="line.1200"></a>
<span class="sourceLineNo">1201</span>     * @return true if the fileNames are equal, null equals null<a name="line.1201"></a>
<span class="sourceLineNo">1202</span>     * @since 1.3<a name="line.1202"></a>
<span class="sourceLineNo">1203</span>     */<a name="line.1203"></a>
<span class="sourceLineNo">1204</span>    public static boolean equals(<a name="line.1204"></a>
<span class="sourceLineNo">1205</span>            String fileName1, String fileName2,<a name="line.1205"></a>
<span class="sourceLineNo">1206</span>            final boolean normalized, IOCase caseSensitivity) {<a name="line.1206"></a>
<span class="sourceLineNo">1207</span><a name="line.1207"></a>
<span class="sourceLineNo">1208</span>        if (fileName1 == null || fileName2 == null) {<a name="line.1208"></a>
<span class="sourceLineNo">1209</span>            return fileName1 == null &amp;&amp; fileName2 == null;<a name="line.1209"></a>
<span class="sourceLineNo">1210</span>        }<a name="line.1210"></a>
<span class="sourceLineNo">1211</span>        if (normalized) {<a name="line.1211"></a>
<span class="sourceLineNo">1212</span>            fileName1 = normalize(fileName1);<a name="line.1212"></a>
<span class="sourceLineNo">1213</span>            fileName2 = normalize(fileName2);<a name="line.1213"></a>
<span class="sourceLineNo">1214</span>            Objects.requireNonNull(fileName1, "Error normalizing one or both of the file names");<a name="line.1214"></a>
<span class="sourceLineNo">1215</span>            Objects.requireNonNull(fileName2, "Error normalizing one or both of the file names");<a name="line.1215"></a>
<span class="sourceLineNo">1216</span>        }<a name="line.1216"></a>
<span class="sourceLineNo">1217</span>        if (caseSensitivity == null) {<a name="line.1217"></a>
<span class="sourceLineNo">1218</span>            caseSensitivity = IOCase.SENSITIVE;<a name="line.1218"></a>
<span class="sourceLineNo">1219</span>        }<a name="line.1219"></a>
<span class="sourceLineNo">1220</span>        return caseSensitivity.checkEquals(fileName1, fileName2);<a name="line.1220"></a>
<span class="sourceLineNo">1221</span>    }<a name="line.1221"></a>
<span class="sourceLineNo">1222</span><a name="line.1222"></a>
<span class="sourceLineNo">1223</span>    //-----------------------------------------------------------------------<a name="line.1223"></a>
<span class="sourceLineNo">1224</span>    /**<a name="line.1224"></a>
<span class="sourceLineNo">1225</span>     * Checks whether the extension of the fileName is that specified.<a name="line.1225"></a>
<span class="sourceLineNo">1226</span>     * &lt;p&gt;<a name="line.1226"></a>
<span class="sourceLineNo">1227</span>     * This method obtains the extension as the textual part of the fileName<a name="line.1227"></a>
<span class="sourceLineNo">1228</span>     * after the last dot. There must be no directory separator after the dot.<a name="line.1228"></a>
<span class="sourceLineNo">1229</span>     * The extension check is case-sensitive on all platforms.<a name="line.1229"></a>
<span class="sourceLineNo">1230</span>     *<a name="line.1230"></a>
<span class="sourceLineNo">1231</span>     * @param fileName  the fileName to query, null returns false<a name="line.1231"></a>
<span class="sourceLineNo">1232</span>     * @param extension  the extension to check for, null or empty checks for no extension<a name="line.1232"></a>
<span class="sourceLineNo">1233</span>     * @return true if the fileName has the specified extension<a name="line.1233"></a>
<span class="sourceLineNo">1234</span>     * @throws java.lang.IllegalArgumentException if the supplied fileName contains null bytes<a name="line.1234"></a>
<span class="sourceLineNo">1235</span>     */<a name="line.1235"></a>
<span class="sourceLineNo">1236</span>    public static boolean isExtension(final String fileName, final String extension) {<a name="line.1236"></a>
<span class="sourceLineNo">1237</span>        if (fileName == null) {<a name="line.1237"></a>
<span class="sourceLineNo">1238</span>            return false;<a name="line.1238"></a>
<span class="sourceLineNo">1239</span>        }<a name="line.1239"></a>
<span class="sourceLineNo">1240</span>        failIfNullBytePresent(fileName);<a name="line.1240"></a>
<span class="sourceLineNo">1241</span><a name="line.1241"></a>
<span class="sourceLineNo">1242</span>        if (extension == null || extension.isEmpty()) {<a name="line.1242"></a>
<span class="sourceLineNo">1243</span>            return indexOfExtension(fileName) == NOT_FOUND;<a name="line.1243"></a>
<span class="sourceLineNo">1244</span>        }<a name="line.1244"></a>
<span class="sourceLineNo">1245</span>        final String fileExt = getExtension(fileName);<a name="line.1245"></a>
<span class="sourceLineNo">1246</span>        return fileExt.equals(extension);<a name="line.1246"></a>
<span class="sourceLineNo">1247</span>    }<a name="line.1247"></a>
<span class="sourceLineNo">1248</span><a name="line.1248"></a>
<span class="sourceLineNo">1249</span>    /**<a name="line.1249"></a>
<span class="sourceLineNo">1250</span>     * Checks whether the extension of the fileName is one of those specified.<a name="line.1250"></a>
<span class="sourceLineNo">1251</span>     * &lt;p&gt;<a name="line.1251"></a>
<span class="sourceLineNo">1252</span>     * This method obtains the extension as the textual part of the fileName<a name="line.1252"></a>
<span class="sourceLineNo">1253</span>     * after the last dot. There must be no directory separator after the dot.<a name="line.1253"></a>
<span class="sourceLineNo">1254</span>     * The extension check is case-sensitive on all platforms.<a name="line.1254"></a>
<span class="sourceLineNo">1255</span>     *<a name="line.1255"></a>
<span class="sourceLineNo">1256</span>     * @param fileName  the fileName to query, null returns false<a name="line.1256"></a>
<span class="sourceLineNo">1257</span>     * @param extensions  the extensions to check for, null checks for no extension<a name="line.1257"></a>
<span class="sourceLineNo">1258</span>     * @return true if the fileName is one of the extensions<a name="line.1258"></a>
<span class="sourceLineNo">1259</span>     * @throws java.lang.IllegalArgumentException if the supplied fileName contains null bytes<a name="line.1259"></a>
<span class="sourceLineNo">1260</span>     */<a name="line.1260"></a>
<span class="sourceLineNo">1261</span>    public static boolean isExtension(final String fileName, final String... extensions) {<a name="line.1261"></a>
<span class="sourceLineNo">1262</span>        if (fileName == null) {<a name="line.1262"></a>
<span class="sourceLineNo">1263</span>            return false;<a name="line.1263"></a>
<span class="sourceLineNo">1264</span>        }<a name="line.1264"></a>
<span class="sourceLineNo">1265</span>        failIfNullBytePresent(fileName);<a name="line.1265"></a>
<span class="sourceLineNo">1266</span><a name="line.1266"></a>
<span class="sourceLineNo">1267</span>        if (extensions == null || extensions.length == 0) {<a name="line.1267"></a>
<span class="sourceLineNo">1268</span>            return indexOfExtension(fileName) == NOT_FOUND;<a name="line.1268"></a>
<span class="sourceLineNo">1269</span>        }<a name="line.1269"></a>
<span class="sourceLineNo">1270</span>        final String fileExt = getExtension(fileName);<a name="line.1270"></a>
<span class="sourceLineNo">1271</span>        for (final String extension : extensions) {<a name="line.1271"></a>
<span class="sourceLineNo">1272</span>            if (fileExt.equals(extension)) {<a name="line.1272"></a>
<span class="sourceLineNo">1273</span>                return true;<a name="line.1273"></a>
<span class="sourceLineNo">1274</span>            }<a name="line.1274"></a>
<span class="sourceLineNo">1275</span>        }<a name="line.1275"></a>
<span class="sourceLineNo">1276</span>        return false;<a name="line.1276"></a>
<span class="sourceLineNo">1277</span>    }<a name="line.1277"></a>
<span class="sourceLineNo">1278</span><a name="line.1278"></a>
<span class="sourceLineNo">1279</span>    /**<a name="line.1279"></a>
<span class="sourceLineNo">1280</span>     * Checks whether the extension of the fileName is one of those specified.<a name="line.1280"></a>
<span class="sourceLineNo">1281</span>     * &lt;p&gt;<a name="line.1281"></a>
<span class="sourceLineNo">1282</span>     * This method obtains the extension as the textual part of the fileName<a name="line.1282"></a>
<span class="sourceLineNo">1283</span>     * after the last dot. There must be no directory separator after the dot.<a name="line.1283"></a>
<span class="sourceLineNo">1284</span>     * The extension check is case-sensitive on all platforms.<a name="line.1284"></a>
<span class="sourceLineNo">1285</span>     *<a name="line.1285"></a>
<span class="sourceLineNo">1286</span>     * @param fileName  the fileName to query, null returns false<a name="line.1286"></a>
<span class="sourceLineNo">1287</span>     * @param extensions  the extensions to check for, null checks for no extension<a name="line.1287"></a>
<span class="sourceLineNo">1288</span>     * @return true if the fileName is one of the extensions<a name="line.1288"></a>
<span class="sourceLineNo">1289</span>     * @throws java.lang.IllegalArgumentException if the supplied fileName contains null bytes<a name="line.1289"></a>
<span class="sourceLineNo">1290</span>     */<a name="line.1290"></a>
<span class="sourceLineNo">1291</span>    public static boolean isExtension(final String fileName, final Collection&lt;String&gt; extensions) {<a name="line.1291"></a>
<span class="sourceLineNo">1292</span>        if (fileName == null) {<a name="line.1292"></a>
<span class="sourceLineNo">1293</span>            return false;<a name="line.1293"></a>
<span class="sourceLineNo">1294</span>        }<a name="line.1294"></a>
<span class="sourceLineNo">1295</span>        failIfNullBytePresent(fileName);<a name="line.1295"></a>
<span class="sourceLineNo">1296</span><a name="line.1296"></a>
<span class="sourceLineNo">1297</span>        if (extensions == null || extensions.isEmpty()) {<a name="line.1297"></a>
<span class="sourceLineNo">1298</span>            return indexOfExtension(fileName) == NOT_FOUND;<a name="line.1298"></a>
<span class="sourceLineNo">1299</span>        }<a name="line.1299"></a>
<span class="sourceLineNo">1300</span>        final String fileExt = getExtension(fileName);<a name="line.1300"></a>
<span class="sourceLineNo">1301</span>        for (final String extension : extensions) {<a name="line.1301"></a>
<span class="sourceLineNo">1302</span>            if (fileExt.equals(extension)) {<a name="line.1302"></a>
<span class="sourceLineNo">1303</span>                return true;<a name="line.1303"></a>
<span class="sourceLineNo">1304</span>            }<a name="line.1304"></a>
<span class="sourceLineNo">1305</span>        }<a name="line.1305"></a>
<span class="sourceLineNo">1306</span>        return false;<a name="line.1306"></a>
<span class="sourceLineNo">1307</span>    }<a name="line.1307"></a>
<span class="sourceLineNo">1308</span><a name="line.1308"></a>
<span class="sourceLineNo">1309</span>    //-----------------------------------------------------------------------<a name="line.1309"></a>
<span class="sourceLineNo">1310</span>    /**<a name="line.1310"></a>
<span class="sourceLineNo">1311</span>     * Checks a fileName to see if it matches the specified wildcard matcher,<a name="line.1311"></a>
<span class="sourceLineNo">1312</span>     * always testing case-sensitive.<a name="line.1312"></a>
<span class="sourceLineNo">1313</span>     * &lt;p&gt;<a name="line.1313"></a>
<span class="sourceLineNo">1314</span>     * The wildcard matcher uses the characters '?' and '*' to represent a<a name="line.1314"></a>
<span class="sourceLineNo">1315</span>     * single or multiple (zero or more) wildcard characters.<a name="line.1315"></a>
<span class="sourceLineNo">1316</span>     * This is the same as often found on Dos/Unix command lines.<a name="line.1316"></a>
<span class="sourceLineNo">1317</span>     * The check is case-sensitive always.<a name="line.1317"></a>
<span class="sourceLineNo">1318</span>     * &lt;pre&gt;<a name="line.1318"></a>
<span class="sourceLineNo">1319</span>     * wildcardMatch("c.txt", "*.txt")      --&amp;gt; true<a name="line.1319"></a>
<span class="sourceLineNo">1320</span>     * wildcardMatch("c.txt", "*.jpg")      --&amp;gt; false<a name="line.1320"></a>
<span class="sourceLineNo">1321</span>     * wildcardMatch("a/b/c.txt", "a/b/*")  --&amp;gt; true<a name="line.1321"></a>
<span class="sourceLineNo">1322</span>     * wildcardMatch("c.txt", "*.???")      --&amp;gt; true<a name="line.1322"></a>
<span class="sourceLineNo">1323</span>     * wildcardMatch("c.txt", "*.????")     --&amp;gt; false<a name="line.1323"></a>
<span class="sourceLineNo">1324</span>     * &lt;/pre&gt;<a name="line.1324"></a>
<span class="sourceLineNo">1325</span>     * N.B. the sequence "*?" does not work properly at present in match strings.<a name="line.1325"></a>
<span class="sourceLineNo">1326</span>     *<a name="line.1326"></a>
<span class="sourceLineNo">1327</span>     * @param fileName  the fileName to match on<a name="line.1327"></a>
<span class="sourceLineNo">1328</span>     * @param wildcardMatcher  the wildcard string to match against<a name="line.1328"></a>
<span class="sourceLineNo">1329</span>     * @return true if the fileName matches the wildcard string<a name="line.1329"></a>
<span class="sourceLineNo">1330</span>     * @see IOCase#SENSITIVE<a name="line.1330"></a>
<span class="sourceLineNo">1331</span>     */<a name="line.1331"></a>
<span class="sourceLineNo">1332</span>    public static boolean wildcardMatch(final String fileName, final String wildcardMatcher) {<a name="line.1332"></a>
<span class="sourceLineNo">1333</span>        return wildcardMatch(fileName, wildcardMatcher, IOCase.SENSITIVE);<a name="line.1333"></a>
<span class="sourceLineNo">1334</span>    }<a name="line.1334"></a>
<span class="sourceLineNo">1335</span><a name="line.1335"></a>
<span class="sourceLineNo">1336</span>    /**<a name="line.1336"></a>
<span class="sourceLineNo">1337</span>     * Checks a fileName to see if it matches the specified wildcard matcher<a name="line.1337"></a>
<span class="sourceLineNo">1338</span>     * using the case rules of the system.<a name="line.1338"></a>
<span class="sourceLineNo">1339</span>     * &lt;p&gt;<a name="line.1339"></a>
<span class="sourceLineNo">1340</span>     * The wildcard matcher uses the characters '?' and '*' to represent a<a name="line.1340"></a>
<span class="sourceLineNo">1341</span>     * single or multiple (zero or more) wildcard characters.<a name="line.1341"></a>
<span class="sourceLineNo">1342</span>     * This is the same as often found on Dos/Unix command lines.<a name="line.1342"></a>
<span class="sourceLineNo">1343</span>     * The check is case-sensitive on Unix and case-insensitive on Windows.<a name="line.1343"></a>
<span class="sourceLineNo">1344</span>     * &lt;pre&gt;<a name="line.1344"></a>
<span class="sourceLineNo">1345</span>     * wildcardMatch("c.txt", "*.txt")      --&amp;gt; true<a name="line.1345"></a>
<span class="sourceLineNo">1346</span>     * wildcardMatch("c.txt", "*.jpg")      --&amp;gt; false<a name="line.1346"></a>
<span class="sourceLineNo">1347</span>     * wildcardMatch("a/b/c.txt", "a/b/*")  --&amp;gt; true<a name="line.1347"></a>
<span class="sourceLineNo">1348</span>     * wildcardMatch("c.txt", "*.???")      --&amp;gt; true<a name="line.1348"></a>
<span class="sourceLineNo">1349</span>     * wildcardMatch("c.txt", "*.????")     --&amp;gt; false<a name="line.1349"></a>
<span class="sourceLineNo">1350</span>     * &lt;/pre&gt;<a name="line.1350"></a>
<span class="sourceLineNo">1351</span>     * N.B. the sequence "*?" does not work properly at present in match strings.<a name="line.1351"></a>
<span class="sourceLineNo">1352</span>     *<a name="line.1352"></a>
<span class="sourceLineNo">1353</span>     * @param fileName  the fileName to match on<a name="line.1353"></a>
<span class="sourceLineNo">1354</span>     * @param wildcardMatcher  the wildcard string to match against<a name="line.1354"></a>
<span class="sourceLineNo">1355</span>     * @return true if the fileName matches the wildcard string<a name="line.1355"></a>
<span class="sourceLineNo">1356</span>     * @see IOCase#SYSTEM<a name="line.1356"></a>
<span class="sourceLineNo">1357</span>     */<a name="line.1357"></a>
<span class="sourceLineNo">1358</span>    public static boolean wildcardMatchOnSystem(final String fileName, final String wildcardMatcher) {<a name="line.1358"></a>
<span class="sourceLineNo">1359</span>        return wildcardMatch(fileName, wildcardMatcher, IOCase.SYSTEM);<a name="line.1359"></a>
<span class="sourceLineNo">1360</span>    }<a name="line.1360"></a>
<span class="sourceLineNo">1361</span><a name="line.1361"></a>
<span class="sourceLineNo">1362</span>    /**<a name="line.1362"></a>
<span class="sourceLineNo">1363</span>     * Checks a fileName to see if it matches the specified wildcard matcher<a name="line.1363"></a>
<span class="sourceLineNo">1364</span>     * allowing control over case-sensitivity.<a name="line.1364"></a>
<span class="sourceLineNo">1365</span>     * &lt;p&gt;<a name="line.1365"></a>
<span class="sourceLineNo">1366</span>     * The wildcard matcher uses the characters '?' and '*' to represent a<a name="line.1366"></a>
<span class="sourceLineNo">1367</span>     * single or multiple (zero or more) wildcard characters.<a name="line.1367"></a>
<span class="sourceLineNo">1368</span>     * N.B. the sequence "*?" does not work properly at present in match strings.<a name="line.1368"></a>
<span class="sourceLineNo">1369</span>     *<a name="line.1369"></a>
<span class="sourceLineNo">1370</span>     * @param fileName  the fileName to match on<a name="line.1370"></a>
<span class="sourceLineNo">1371</span>     * @param wildcardMatcher  the wildcard string to match against<a name="line.1371"></a>
<span class="sourceLineNo">1372</span>     * @param caseSensitivity  what case sensitivity rule to use, null means case-sensitive<a name="line.1372"></a>
<span class="sourceLineNo">1373</span>     * @return true if the fileName matches the wildcard string<a name="line.1373"></a>
<span class="sourceLineNo">1374</span>     * @since 1.3<a name="line.1374"></a>
<span class="sourceLineNo">1375</span>     */<a name="line.1375"></a>
<span class="sourceLineNo">1376</span>    public static boolean wildcardMatch(final String fileName, final String wildcardMatcher, IOCase caseSensitivity) {<a name="line.1376"></a>
<span class="sourceLineNo">1377</span>        if (fileName == null &amp;&amp; wildcardMatcher == null) {<a name="line.1377"></a>
<span class="sourceLineNo">1378</span>            return true;<a name="line.1378"></a>
<span class="sourceLineNo">1379</span>        }<a name="line.1379"></a>
<span class="sourceLineNo">1380</span>        if (fileName == null || wildcardMatcher == null) {<a name="line.1380"></a>
<span class="sourceLineNo">1381</span>            return false;<a name="line.1381"></a>
<span class="sourceLineNo">1382</span>        }<a name="line.1382"></a>
<span class="sourceLineNo">1383</span>        if (caseSensitivity == null) {<a name="line.1383"></a>
<span class="sourceLineNo">1384</span>            caseSensitivity = IOCase.SENSITIVE;<a name="line.1384"></a>
<span class="sourceLineNo">1385</span>        }<a name="line.1385"></a>
<span class="sourceLineNo">1386</span>        final String[] wcs = splitOnTokens(wildcardMatcher);<a name="line.1386"></a>
<span class="sourceLineNo">1387</span>        boolean anyChars = false;<a name="line.1387"></a>
<span class="sourceLineNo">1388</span>        int textIdx = 0;<a name="line.1388"></a>
<span class="sourceLineNo">1389</span>        int wcsIdx = 0;<a name="line.1389"></a>
<span class="sourceLineNo">1390</span>        final Deque&lt;int[]&gt; backtrack = new ArrayDeque&lt;&gt;(wcs.length);<a name="line.1390"></a>
<span class="sourceLineNo">1391</span><a name="line.1391"></a>
<span class="sourceLineNo">1392</span>        // loop around a backtrack stack, to handle complex * matching<a name="line.1392"></a>
<span class="sourceLineNo">1393</span>        do {<a name="line.1393"></a>
<span class="sourceLineNo">1394</span>            if (!backtrack.isEmpty()) {<a name="line.1394"></a>
<span class="sourceLineNo">1395</span>                final int[] array = backtrack.pop();<a name="line.1395"></a>
<span class="sourceLineNo">1396</span>                wcsIdx = array[0];<a name="line.1396"></a>
<span class="sourceLineNo">1397</span>                textIdx = array[1];<a name="line.1397"></a>
<span class="sourceLineNo">1398</span>                anyChars = true;<a name="line.1398"></a>
<span class="sourceLineNo">1399</span>            }<a name="line.1399"></a>
<span class="sourceLineNo">1400</span><a name="line.1400"></a>
<span class="sourceLineNo">1401</span>            // loop whilst tokens and text left to process<a name="line.1401"></a>
<span class="sourceLineNo">1402</span>            while (wcsIdx &lt; wcs.length) {<a name="line.1402"></a>
<span class="sourceLineNo">1403</span><a name="line.1403"></a>
<span class="sourceLineNo">1404</span>                if (wcs[wcsIdx].equals("?")) {<a name="line.1404"></a>
<span class="sourceLineNo">1405</span>                    // ? so move to next text char<a name="line.1405"></a>
<span class="sourceLineNo">1406</span>                    textIdx++;<a name="line.1406"></a>
<span class="sourceLineNo">1407</span>                    if (textIdx &gt; fileName.length()) {<a name="line.1407"></a>
<span class="sourceLineNo">1408</span>                        break;<a name="line.1408"></a>
<span class="sourceLineNo">1409</span>                    }<a name="line.1409"></a>
<span class="sourceLineNo">1410</span>                    anyChars = false;<a name="line.1410"></a>
<span class="sourceLineNo">1411</span><a name="line.1411"></a>
<span class="sourceLineNo">1412</span>                } else if (wcs[wcsIdx].equals("*")) {<a name="line.1412"></a>
<span class="sourceLineNo">1413</span>                    // set any chars status<a name="line.1413"></a>
<span class="sourceLineNo">1414</span>                    anyChars = true;<a name="line.1414"></a>
<span class="sourceLineNo">1415</span>                    if (wcsIdx == wcs.length - 1) {<a name="line.1415"></a>
<span class="sourceLineNo">1416</span>                        textIdx = fileName.length();<a name="line.1416"></a>
<span class="sourceLineNo">1417</span>                    }<a name="line.1417"></a>
<span class="sourceLineNo">1418</span><a name="line.1418"></a>
<span class="sourceLineNo">1419</span>                } else {<a name="line.1419"></a>
<span class="sourceLineNo">1420</span>                    // matching text token<a name="line.1420"></a>
<span class="sourceLineNo">1421</span>                    if (anyChars) {<a name="line.1421"></a>
<span class="sourceLineNo">1422</span>                        // any chars then try to locate text token<a name="line.1422"></a>
<span class="sourceLineNo">1423</span>                        textIdx = caseSensitivity.checkIndexOf(fileName, textIdx, wcs[wcsIdx]);<a name="line.1423"></a>
<span class="sourceLineNo">1424</span>                        if (textIdx == NOT_FOUND) {<a name="line.1424"></a>
<span class="sourceLineNo">1425</span>                            // token not found<a name="line.1425"></a>
<span class="sourceLineNo">1426</span>                            break;<a name="line.1426"></a>
<span class="sourceLineNo">1427</span>                        }<a name="line.1427"></a>
<span class="sourceLineNo">1428</span>                        final int repeat = caseSensitivity.checkIndexOf(fileName, textIdx + 1, wcs[wcsIdx]);<a name="line.1428"></a>
<span class="sourceLineNo">1429</span>                        if (repeat &gt;= 0) {<a name="line.1429"></a>
<span class="sourceLineNo">1430</span>                            backtrack.push(new int[] {wcsIdx, repeat});<a name="line.1430"></a>
<span class="sourceLineNo">1431</span>                        }<a name="line.1431"></a>
<span class="sourceLineNo">1432</span>                    } else {<a name="line.1432"></a>
<span class="sourceLineNo">1433</span>                        // matching from current position<a name="line.1433"></a>
<span class="sourceLineNo">1434</span>                        if (!caseSensitivity.checkRegionMatches(fileName, textIdx, wcs[wcsIdx])) {<a name="line.1434"></a>
<span class="sourceLineNo">1435</span>                            // couldnt match token<a name="line.1435"></a>
<span class="sourceLineNo">1436</span>                            break;<a name="line.1436"></a>
<span class="sourceLineNo">1437</span>                        }<a name="line.1437"></a>
<span class="sourceLineNo">1438</span>                    }<a name="line.1438"></a>
<span class="sourceLineNo">1439</span><a name="line.1439"></a>
<span class="sourceLineNo">1440</span>                    // matched text token, move text index to end of matched token<a name="line.1440"></a>
<span class="sourceLineNo">1441</span>                    textIdx += wcs[wcsIdx].length();<a name="line.1441"></a>
<span class="sourceLineNo">1442</span>                    anyChars = false;<a name="line.1442"></a>
<span class="sourceLineNo">1443</span>                }<a name="line.1443"></a>
<span class="sourceLineNo">1444</span><a name="line.1444"></a>
<span class="sourceLineNo">1445</span>                wcsIdx++;<a name="line.1445"></a>
<span class="sourceLineNo">1446</span>            }<a name="line.1446"></a>
<span class="sourceLineNo">1447</span><a name="line.1447"></a>
<span class="sourceLineNo">1448</span>            // full match<a name="line.1448"></a>
<span class="sourceLineNo">1449</span>            if (wcsIdx == wcs.length &amp;&amp; textIdx == fileName.length()) {<a name="line.1449"></a>
<span class="sourceLineNo">1450</span>                return true;<a name="line.1450"></a>
<span class="sourceLineNo">1451</span>            }<a name="line.1451"></a>
<span class="sourceLineNo">1452</span><a name="line.1452"></a>
<span class="sourceLineNo">1453</span>        } while (!backtrack.isEmpty());<a name="line.1453"></a>
<span class="sourceLineNo">1454</span><a name="line.1454"></a>
<span class="sourceLineNo">1455</span>        return false;<a name="line.1455"></a>
<span class="sourceLineNo">1456</span>    }<a name="line.1456"></a>
<span class="sourceLineNo">1457</span><a name="line.1457"></a>
<span class="sourceLineNo">1458</span>    /**<a name="line.1458"></a>
<span class="sourceLineNo">1459</span>     * Splits a string into a number of tokens.<a name="line.1459"></a>
<span class="sourceLineNo">1460</span>     * The text is split by '?' and '*'.<a name="line.1460"></a>
<span class="sourceLineNo">1461</span>     * Where multiple '*' occur consecutively they are collapsed into a single '*'.<a name="line.1461"></a>
<span class="sourceLineNo">1462</span>     *<a name="line.1462"></a>
<span class="sourceLineNo">1463</span>     * @param text  the text to split<a name="line.1463"></a>
<span class="sourceLineNo">1464</span>     * @return the array of tokens, never null<a name="line.1464"></a>
<span class="sourceLineNo">1465</span>     */<a name="line.1465"></a>
<span class="sourceLineNo">1466</span>    static String[] splitOnTokens(final String text) {<a name="line.1466"></a>
<span class="sourceLineNo">1467</span>        // used by wildcardMatch<a name="line.1467"></a>
<span class="sourceLineNo">1468</span>        // package level so a unit test may run on this<a name="line.1468"></a>
<span class="sourceLineNo">1469</span><a name="line.1469"></a>
<span class="sourceLineNo">1470</span>        if (text.indexOf('?') == NOT_FOUND &amp;&amp; text.indexOf('*') == NOT_FOUND) {<a name="line.1470"></a>
<span class="sourceLineNo">1471</span>            return new String[] { text };<a name="line.1471"></a>
<span class="sourceLineNo">1472</span>        }<a name="line.1472"></a>
<span class="sourceLineNo">1473</span><a name="line.1473"></a>
<span class="sourceLineNo">1474</span>        final char[] array = text.toCharArray();<a name="line.1474"></a>
<span class="sourceLineNo">1475</span>        final ArrayList&lt;String&gt; list = new ArrayList&lt;&gt;();<a name="line.1475"></a>
<span class="sourceLineNo">1476</span>        final StringBuilder buffer = new StringBuilder();<a name="line.1476"></a>
<span class="sourceLineNo">1477</span>        char prevChar = 0;<a name="line.1477"></a>
<span class="sourceLineNo">1478</span>        for (final char ch : array) {<a name="line.1478"></a>
<span class="sourceLineNo">1479</span>            if (ch == '?' || ch == '*') {<a name="line.1479"></a>
<span class="sourceLineNo">1480</span>                if (buffer.length() != 0) {<a name="line.1480"></a>
<span class="sourceLineNo">1481</span>                    list.add(buffer.toString());<a name="line.1481"></a>
<span class="sourceLineNo">1482</span>                    buffer.setLength(0);<a name="line.1482"></a>
<span class="sourceLineNo">1483</span>                }<a name="line.1483"></a>
<span class="sourceLineNo">1484</span>                if (ch == '?') {<a name="line.1484"></a>
<span class="sourceLineNo">1485</span>                    list.add("?");<a name="line.1485"></a>
<span class="sourceLineNo">1486</span>                } else if (prevChar != '*') {// ch == '*' here; check if previous char was '*'<a name="line.1486"></a>
<span class="sourceLineNo">1487</span>                    list.add("*");<a name="line.1487"></a>
<span class="sourceLineNo">1488</span>                }<a name="line.1488"></a>
<span class="sourceLineNo">1489</span>            } else {<a name="line.1489"></a>
<span class="sourceLineNo">1490</span>                buffer.append(ch);<a name="line.1490"></a>
<span class="sourceLineNo">1491</span>            }<a name="line.1491"></a>
<span class="sourceLineNo">1492</span>            prevChar = ch;<a name="line.1492"></a>
<span class="sourceLineNo">1493</span>        }<a name="line.1493"></a>
<span class="sourceLineNo">1494</span>        if (buffer.length() != 0) {<a name="line.1494"></a>
<span class="sourceLineNo">1495</span>            list.add(buffer.toString());<a name="line.1495"></a>
<span class="sourceLineNo">1496</span>        }<a name="line.1496"></a>
<span class="sourceLineNo">1497</span><a name="line.1497"></a>
<span class="sourceLineNo">1498</span>        return list.toArray(EMPTY_STRING_ARRAY);<a name="line.1498"></a>
<span class="sourceLineNo">1499</span>    }<a name="line.1499"></a>
<span class="sourceLineNo">1500</span><a name="line.1500"></a>
<span class="sourceLineNo">1501</span>    /**<a name="line.1501"></a>
<span class="sourceLineNo">1502</span>     * Checks whether a given string is a valid host name according to<a name="line.1502"></a>
<span class="sourceLineNo">1503</span>     * RFC 3986.<a name="line.1503"></a>
<span class="sourceLineNo">1504</span>     *<a name="line.1504"></a>
<span class="sourceLineNo">1505</span>     * &lt;p&gt;Accepted are IP addresses (v4 and v6) as well as what the<a name="line.1505"></a>
<span class="sourceLineNo">1506</span>     * RFC calls a "reg-name". Percent encoded names don't seem to be<a name="line.1506"></a>
<span class="sourceLineNo">1507</span>     * valid names in UNC paths.&lt;/p&gt;<a name="line.1507"></a>
<span class="sourceLineNo">1508</span>     *<a name="line.1508"></a>
<span class="sourceLineNo">1509</span>     * @see "https://tools.ietf.org/html/rfc3986#section-3.2.2"<a name="line.1509"></a>
<span class="sourceLineNo">1510</span>     * @param name the hostname to validate<a name="line.1510"></a>
<span class="sourceLineNo">1511</span>     * @return true if the given name is a valid host name<a name="line.1511"></a>
<span class="sourceLineNo">1512</span>     */<a name="line.1512"></a>
<span class="sourceLineNo">1513</span>    private static boolean isValidHostName(final String name) {<a name="line.1513"></a>
<span class="sourceLineNo">1514</span>        return isIPv6Address(name) || isRFC3986HostName(name);<a name="line.1514"></a>
<span class="sourceLineNo">1515</span>    }<a name="line.1515"></a>
<span class="sourceLineNo">1516</span><a name="line.1516"></a>
<span class="sourceLineNo">1517</span>    private static final Pattern IPV4_PATTERN =<a name="line.1517"></a>
<span class="sourceLineNo">1518</span>        Pattern.compile("^(\\d{1,3})\\.(\\d{1,3})\\.(\\d{1,3})\\.(\\d{1,3})$");<a name="line.1518"></a>
<span class="sourceLineNo">1519</span>    private static final int IPV4_MAX_OCTET_VALUE = 255;<a name="line.1519"></a>
<span class="sourceLineNo">1520</span><a name="line.1520"></a>
<span class="sourceLineNo">1521</span>    /**<a name="line.1521"></a>
<span class="sourceLineNo">1522</span>     * Checks whether a given string represents a valid IPv4 address.<a name="line.1522"></a>
<span class="sourceLineNo">1523</span>     *<a name="line.1523"></a>
<span class="sourceLineNo">1524</span>     * @param name the name to validate<a name="line.1524"></a>
<span class="sourceLineNo">1525</span>     * @return true if the given name is a valid IPv4 address<a name="line.1525"></a>
<span class="sourceLineNo">1526</span>     */<a name="line.1526"></a>
<span class="sourceLineNo">1527</span>    // mostly copied from org.apache.commons.validator.routines.InetAddressValidator#isValidInet4Address<a name="line.1527"></a>
<span class="sourceLineNo">1528</span>    private static boolean isIPv4Address(final String name) {<a name="line.1528"></a>
<span class="sourceLineNo">1529</span>        final Matcher m = IPV4_PATTERN.matcher(name);<a name="line.1529"></a>
<span class="sourceLineNo">1530</span>        if (!m.matches() || m.groupCount() != 4) {<a name="line.1530"></a>
<span class="sourceLineNo">1531</span>            return false;<a name="line.1531"></a>
<span class="sourceLineNo">1532</span>        }<a name="line.1532"></a>
<span class="sourceLineNo">1533</span><a name="line.1533"></a>
<span class="sourceLineNo">1534</span>        // verify that address subgroups are legal<a name="line.1534"></a>
<span class="sourceLineNo">1535</span>        for (int i = 1; i &lt;= 4; i++) {<a name="line.1535"></a>
<span class="sourceLineNo">1536</span>            final String ipSegment = m.group(i);<a name="line.1536"></a>
<span class="sourceLineNo">1537</span>            final int iIpSegment = Integer.parseInt(ipSegment);<a name="line.1537"></a>
<span class="sourceLineNo">1538</span>            if (iIpSegment &gt; IPV4_MAX_OCTET_VALUE) {<a name="line.1538"></a>
<span class="sourceLineNo">1539</span>                return false;<a name="line.1539"></a>
<span class="sourceLineNo">1540</span>            }<a name="line.1540"></a>
<span class="sourceLineNo">1541</span><a name="line.1541"></a>
<span class="sourceLineNo">1542</span>            if (ipSegment.length() &gt; 1 &amp;&amp; ipSegment.startsWith("0")) {<a name="line.1542"></a>
<span class="sourceLineNo">1543</span>                return false;<a name="line.1543"></a>
<span class="sourceLineNo">1544</span>            }<a name="line.1544"></a>
<span class="sourceLineNo">1545</span><a name="line.1545"></a>
<span class="sourceLineNo">1546</span>        }<a name="line.1546"></a>
<span class="sourceLineNo">1547</span><a name="line.1547"></a>
<span class="sourceLineNo">1548</span>        return true;<a name="line.1548"></a>
<span class="sourceLineNo">1549</span>    }<a name="line.1549"></a>
<span class="sourceLineNo">1550</span><a name="line.1550"></a>
<span class="sourceLineNo">1551</span>    private static final int IPV6_MAX_HEX_GROUPS = 8;<a name="line.1551"></a>
<span class="sourceLineNo">1552</span>    private static final int IPV6_MAX_HEX_DIGITS_PER_GROUP = 4;<a name="line.1552"></a>
<span class="sourceLineNo">1553</span>    private static final int MAX_UNSIGNED_SHORT = 0xffff;<a name="line.1553"></a>
<span class="sourceLineNo">1554</span>    private static final int BASE_16 = 16;<a name="line.1554"></a>
<span class="sourceLineNo">1555</span><a name="line.1555"></a>
<span class="sourceLineNo">1556</span>    // copied from org.apache.commons.validator.routines.InetAddressValidator#isValidInet6Address<a name="line.1556"></a>
<span class="sourceLineNo">1557</span>    /**<a name="line.1557"></a>
<span class="sourceLineNo">1558</span>     * Checks whether a given string represents a valid IPv6 address.<a name="line.1558"></a>
<span class="sourceLineNo">1559</span>     *<a name="line.1559"></a>
<span class="sourceLineNo">1560</span>     * @param inet6Address the name to validate<a name="line.1560"></a>
<span class="sourceLineNo">1561</span>     * @return true if the given name is a valid IPv6 address<a name="line.1561"></a>
<span class="sourceLineNo">1562</span>     */<a name="line.1562"></a>
<span class="sourceLineNo">1563</span>    private static boolean isIPv6Address(final String inet6Address) {<a name="line.1563"></a>
<span class="sourceLineNo">1564</span>        final boolean containsCompressedZeroes = inet6Address.contains("::");<a name="line.1564"></a>
<span class="sourceLineNo">1565</span>        if (containsCompressedZeroes &amp;&amp; (inet6Address.indexOf("::") != inet6Address.lastIndexOf("::"))) {<a name="line.1565"></a>
<span class="sourceLineNo">1566</span>            return false;<a name="line.1566"></a>
<span class="sourceLineNo">1567</span>        }<a name="line.1567"></a>
<span class="sourceLineNo">1568</span>        if ((inet6Address.startsWith(":") &amp;&amp; !inet6Address.startsWith("::"))<a name="line.1568"></a>
<span class="sourceLineNo">1569</span>                || (inet6Address.endsWith(":") &amp;&amp; !inet6Address.endsWith("::"))) {<a name="line.1569"></a>
<span class="sourceLineNo">1570</span>            return false;<a name="line.1570"></a>
<span class="sourceLineNo">1571</span>        }<a name="line.1571"></a>
<span class="sourceLineNo">1572</span>        String[] octets = inet6Address.split(":");<a name="line.1572"></a>
<span class="sourceLineNo">1573</span>        if (containsCompressedZeroes) {<a name="line.1573"></a>
<span class="sourceLineNo">1574</span>            final List&lt;String&gt; octetList = new ArrayList&lt;&gt;(Arrays.asList(octets));<a name="line.1574"></a>
<span class="sourceLineNo">1575</span>            if (inet6Address.endsWith("::")) {<a name="line.1575"></a>
<span class="sourceLineNo">1576</span>                // String.split() drops ending empty segments<a name="line.1576"></a>
<span class="sourceLineNo">1577</span>                octetList.add("");<a name="line.1577"></a>
<span class="sourceLineNo">1578</span>            } else if (inet6Address.startsWith("::") &amp;&amp; !octetList.isEmpty()) {<a name="line.1578"></a>
<span class="sourceLineNo">1579</span>                octetList.remove(0);<a name="line.1579"></a>
<span class="sourceLineNo">1580</span>            }<a name="line.1580"></a>
<span class="sourceLineNo">1581</span>            octets = octetList.toArray(EMPTY_STRING_ARRAY);<a name="line.1581"></a>
<span class="sourceLineNo">1582</span>        }<a name="line.1582"></a>
<span class="sourceLineNo">1583</span>        if (octets.length &gt; IPV6_MAX_HEX_GROUPS) {<a name="line.1583"></a>
<span class="sourceLineNo">1584</span>            return false;<a name="line.1584"></a>
<span class="sourceLineNo">1585</span>        }<a name="line.1585"></a>
<span class="sourceLineNo">1586</span>        int validOctets = 0;<a name="line.1586"></a>
<span class="sourceLineNo">1587</span>        int emptyOctets = 0; // consecutive empty chunks<a name="line.1587"></a>
<span class="sourceLineNo">1588</span>        for (int index = 0; index &lt; octets.length; index++) {<a name="line.1588"></a>
<span class="sourceLineNo">1589</span>            final String octet = octets[index];<a name="line.1589"></a>
<span class="sourceLineNo">1590</span>            if (octet.length() == 0) {<a name="line.1590"></a>
<span class="sourceLineNo">1591</span>                emptyOctets++;<a name="line.1591"></a>
<span class="sourceLineNo">1592</span>                if (emptyOctets &gt; 1) {<a name="line.1592"></a>
<span class="sourceLineNo">1593</span>                    return false;<a name="line.1593"></a>
<span class="sourceLineNo">1594</span>                }<a name="line.1594"></a>
<span class="sourceLineNo">1595</span>            } else {<a name="line.1595"></a>
<span class="sourceLineNo">1596</span>                emptyOctets = 0;<a name="line.1596"></a>
<span class="sourceLineNo">1597</span>                // Is last chunk an IPv4 address?<a name="line.1597"></a>
<span class="sourceLineNo">1598</span>                if (index == octets.length - 1 &amp;&amp; octet.contains(".")) {<a name="line.1598"></a>
<span class="sourceLineNo">1599</span>                    if (!isIPv4Address(octet)) {<a name="line.1599"></a>
<span class="sourceLineNo">1600</span>                        return false;<a name="line.1600"></a>
<span class="sourceLineNo">1601</span>                    }<a name="line.1601"></a>
<span class="sourceLineNo">1602</span>                    validOctets += 2;<a name="line.1602"></a>
<span class="sourceLineNo">1603</span>                    continue;<a name="line.1603"></a>
<span class="sourceLineNo">1604</span>                }<a name="line.1604"></a>
<span class="sourceLineNo">1605</span>                if (octet.length() &gt; IPV6_MAX_HEX_DIGITS_PER_GROUP) {<a name="line.1605"></a>
<span class="sourceLineNo">1606</span>                    return false;<a name="line.1606"></a>
<span class="sourceLineNo">1607</span>                }<a name="line.1607"></a>
<span class="sourceLineNo">1608</span>                int octetInt = 0;<a name="line.1608"></a>
<span class="sourceLineNo">1609</span>                try {<a name="line.1609"></a>
<span class="sourceLineNo">1610</span>                    octetInt = Integer.parseInt(octet, BASE_16);<a name="line.1610"></a>
<span class="sourceLineNo">1611</span>                } catch (final NumberFormatException e) {<a name="line.1611"></a>
<span class="sourceLineNo">1612</span>                    return false;<a name="line.1612"></a>
<span class="sourceLineNo">1613</span>                }<a name="line.1613"></a>
<span class="sourceLineNo">1614</span>                if (octetInt &lt; 0 || octetInt &gt; MAX_UNSIGNED_SHORT) {<a name="line.1614"></a>
<span class="sourceLineNo">1615</span>                    return false;<a name="line.1615"></a>
<span class="sourceLineNo">1616</span>                }<a name="line.1616"></a>
<span class="sourceLineNo">1617</span>            }<a name="line.1617"></a>
<span class="sourceLineNo">1618</span>            validOctets++;<a name="line.1618"></a>
<span class="sourceLineNo">1619</span>        }<a name="line.1619"></a>
<span class="sourceLineNo">1620</span>        return validOctets &lt;= IPV6_MAX_HEX_GROUPS &amp;&amp; (validOctets &gt;= IPV6_MAX_HEX_GROUPS || containsCompressedZeroes);<a name="line.1620"></a>
<span class="sourceLineNo">1621</span>    }<a name="line.1621"></a>
<span class="sourceLineNo">1622</span><a name="line.1622"></a>
<span class="sourceLineNo">1623</span>    private static final Pattern REG_NAME_PART_PATTERN = Pattern.compile("^[a-zA-Z0-9][a-zA-Z0-9-]*$");<a name="line.1623"></a>
<span class="sourceLineNo">1624</span><a name="line.1624"></a>
<span class="sourceLineNo">1625</span>    /**<a name="line.1625"></a>
<span class="sourceLineNo">1626</span>     * Checks whether a given string is a valid host name according to<a name="line.1626"></a>
<span class="sourceLineNo">1627</span>     * RFC 3986 - not accepting IP addresses.<a name="line.1627"></a>
<span class="sourceLineNo">1628</span>     *<a name="line.1628"></a>
<span class="sourceLineNo">1629</span>     * @see "https://tools.ietf.org/html/rfc3986#section-3.2.2"<a name="line.1629"></a>
<span class="sourceLineNo">1630</span>     * @param name the hostname to validate<a name="line.1630"></a>
<span class="sourceLineNo">1631</span>     * @return true if the given name is a valid host name<a name="line.1631"></a>
<span class="sourceLineNo">1632</span>     */<a name="line.1632"></a>
<span class="sourceLineNo">1633</span>    private static boolean isRFC3986HostName(final String name) {<a name="line.1633"></a>
<span class="sourceLineNo">1634</span>        final String[] parts = name.split("\\.", -1);<a name="line.1634"></a>
<span class="sourceLineNo">1635</span>        for (int i = 0; i &lt; parts.length; i++) {<a name="line.1635"></a>
<span class="sourceLineNo">1636</span>            if (parts[i].length() == 0) {<a name="line.1636"></a>
<span class="sourceLineNo">1637</span>                // trailing dot is legal, otherwise we've hit a .. sequence<a name="line.1637"></a>
<span class="sourceLineNo">1638</span>                return i == parts.length - 1;<a name="line.1638"></a>
<span class="sourceLineNo">1639</span>            }<a name="line.1639"></a>
<span class="sourceLineNo">1640</span>            if (!REG_NAME_PART_PATTERN.matcher(parts[i]).matches()) {<a name="line.1640"></a>
<span class="sourceLineNo">1641</span>                return false;<a name="line.1641"></a>
<span class="sourceLineNo">1642</span>            }<a name="line.1642"></a>
<span class="sourceLineNo">1643</span>        }<a name="line.1643"></a>
<span class="sourceLineNo">1644</span>        return true;<a name="line.1644"></a>
<span class="sourceLineNo">1645</span>    }<a name="line.1645"></a>
<span class="sourceLineNo">1646</span>}<a name="line.1646"></a>




























































</pre>
</div>
</body>
</html>
